@aspen.cloud/cli
v0.0.0
Published
Command Line Utility for developing and deploying apps for Aspen Spaces
Downloads
49
Keywords
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @aspen.cloud/cli
$ aspen COMMAND
running command...
$ aspen (--version)
@aspen.cloud/cli/0.0.0 darwin-arm64 node-v16.13.0
$ aspen --help [COMMAND]
USAGE
$ aspen COMMAND
...
Commands
aspen dev
aspen help [COMMAND]
aspen init [PROJECTPATH]
aspen plugins
aspen plugins:install PLUGIN...
aspen plugins:inspect PLUGIN...
aspen plugins:install PLUGIN...
aspen plugins:link PLUGIN
aspen plugins:uninstall PLUGIN...
aspen plugins:uninstall PLUGIN...
aspen plugins:uninstall PLUGIN...
aspen plugins update
aspen dev
describe the command here
USAGE
$ aspen dev [-f <value>]
FLAGS
-f, --frontend_port=<value> [default: 5173] the port the frontend dev server runs on
DESCRIPTION
describe the command here
EXAMPLES
$ aspen dev
See code: dist/commands/dev.ts
aspen help [COMMAND]
Display help for aspen.
USAGE
$ aspen help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for aspen.
See code: @oclif/plugin-help
aspen init [PROJECTPATH]
Initialize your app. Works with existing frontends or brand new projects.
USAGE
$ aspen init [PROJECTPATH] [-t <value>] [-n <value>]
FLAGS
-n, --name=<value> name of your app
-t, --template=<value> Vite template to use
DESCRIPTION
Initialize your app. Works with existing frontends or brand new projects.
EXAMPLES
$ aspen init
See code: dist/commands/init.ts
aspen plugins
List installed plugins.
USAGE
$ aspen plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ aspen plugins
See code: @oclif/plugin-plugins
aspen plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ aspen plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ aspen plugins add
EXAMPLES
$ aspen plugins:install myplugin
$ aspen plugins:install https://github.com/someuser/someplugin
$ aspen plugins:install someuser/someplugin
aspen plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ aspen plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ aspen plugins:inspect myplugin
aspen plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ aspen plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ aspen plugins add
EXAMPLES
$ aspen plugins:install myplugin
$ aspen plugins:install https://github.com/someuser/someplugin
$ aspen plugins:install someuser/someplugin
aspen plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ aspen plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ aspen plugins:link myplugin
aspen plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ aspen plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ aspen plugins unlink
$ aspen plugins remove
aspen plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ aspen plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ aspen plugins unlink
$ aspen plugins remove
aspen plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ aspen plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ aspen plugins unlink
$ aspen plugins remove
aspen plugins update
Update installed plugins.
USAGE
$ aspen plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.