README
cli
The shockpkg CLI
Overview
The CLI package manager for shockpkg packages.
Usage
$ npm install -g @shockpkg/cli
$ shockpkg COMMAND
running command...
$ shockpkg (-v|--version|version)
@shockpkg/cli/1.7.0 darwin-x64 node-v14.17.3
$ shockpkg --help [COMMAND]
USAGE
$ shockpkg COMMAND
...
Commands
shockpkg about
shockpkg available
shockpkg cleanup
shockpkg file PACKAGE
shockpkg help [COMMAND]
shockpkg info PACKAGE
shockpkg install PACKAGES
shockpkg install-full PACKAGES
shockpkg install-slim PACKAGES
shockpkg installed
shockpkg is-current PACKAGE
shockpkg is-installed PACKAGE
shockpkg is-obsolete PACKAGE
shockpkg list
shockpkg obsolete
shockpkg outdated
shockpkg path
shockpkg remove PACKAGES
shockpkg update
shockpkg upgrade
shockpkg upgrade-full
shockpkg upgrade-slim
shockpkg url
shockpkg verify PACKAGE
shockpkg about
display info about program
USAGE
$ shockpkg about
OPTIONS
-h, --help show CLI help
See code: src/commands/about.ts
shockpkg available
list the available packages not installed
USAGE
$ shockpkg available
OPTIONS
-h, --help show CLI help
See code: src/commands/available.ts
shockpkg cleanup
cleanup temporary files and obsolete packages
USAGE
$ shockpkg cleanup
OPTIONS
-h, --help show CLI help
See code: src/commands/cleanup.ts
shockpkg file PACKAGE
get package file path
USAGE
$ shockpkg file PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/file.ts
shockpkg help [COMMAND]
display help for shockpkg
USAGE
$ shockpkg help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
shockpkg info PACKAGE
view info for package
USAGE
$ shockpkg info PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/info.ts
shockpkg install PACKAGES
install packages, slim method, fallback on full method
USAGE
$ shockpkg install PACKAGES
ARGUMENTS
PACKAGES list of packages to be installed
OPTIONS
-h, --help show CLI help
See code: src/commands/install.ts
shockpkg install-full PACKAGES
install packages, full method
USAGE
$ shockpkg install-full PACKAGES
ARGUMENTS
PACKAGES list of packages to be installed
OPTIONS
-h, --help show CLI help
See code: src/commands/install-full.ts
shockpkg install-slim PACKAGES
install packages, slim method
USAGE
$ shockpkg install-slim PACKAGES
ARGUMENTS
PACKAGES list of packages to be installed
OPTIONS
-h, --help show CLI help
See code: src/commands/install-slim.ts
shockpkg installed
list the installed packages
USAGE
$ shockpkg installed
OPTIONS
-h, --help show CLI help
See code: src/commands/installed.ts
shockpkg is-current PACKAGE
check package is installed and current
USAGE
$ shockpkg is-current PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/is-current.ts
shockpkg is-installed PACKAGE
check package is installed
USAGE
$ shockpkg is-installed PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/is-installed.ts
shockpkg is-obsolete PACKAGE
check package is obsolete
USAGE
$ shockpkg is-obsolete PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/is-obsolete.ts
shockpkg list
list all the packages in the package list
USAGE
$ shockpkg list
OPTIONS
-h, --help show CLI help
See code: src/commands/list.ts
shockpkg obsolete
list the obsolete packages
USAGE
$ shockpkg obsolete
OPTIONS
-h, --help show CLI help
See code: src/commands/obsolete.ts
shockpkg outdated
list the outdated packages
USAGE
$ shockpkg outdated
OPTIONS
-h, --help show CLI help
See code: src/commands/outdated.ts
shockpkg path
get package manager path
USAGE
$ shockpkg path
OPTIONS
-h, --help show CLI help
See code: src/commands/path.ts
shockpkg remove PACKAGES
remove packages
USAGE
$ shockpkg remove PACKAGES
ARGUMENTS
PACKAGES list of packages to be removed
OPTIONS
-h, --help show CLI help
See code: src/commands/remove.ts
shockpkg update
update the packages list
USAGE
$ shockpkg update
OPTIONS
-h, --help show CLI help
-s, --summary Summarize the updated packages
See code: src/commands/update.ts
shockpkg upgrade
install packages, slim method
USAGE
$ shockpkg upgrade
OPTIONS
-h, --help show CLI help
See code: src/commands/upgrade.ts
shockpkg upgrade-full
install packages, full method
USAGE
$ shockpkg upgrade-full
OPTIONS
-h, --help show CLI help
See code: src/commands/upgrade-full.ts
shockpkg upgrade-slim
install packages, slim method
USAGE
$ shockpkg upgrade-slim
OPTIONS
-h, --help show CLI help
See code: src/commands/upgrade-slim.ts
shockpkg url
get package manager package list URL
USAGE
$ shockpkg url
OPTIONS
-h, --help show CLI help
See code: src/commands/url.ts
shockpkg verify PACKAGE
verify an installed package
USAGE
$ shockpkg verify PACKAGE
ARGUMENTS
PACKAGE package id
OPTIONS
-h, --help show CLI help
See code: src/commands/verify.ts
Bugs
If you find a bug or have compatibility issues, please open a ticket under issues section for this repository.
License
Copyright (c) 2018-2021 JrMasterModelBuilder
Licensed under the Mozilla Public License, v. 2.0.
If this license does not work for you, feel free to contact me.