The Admin CLI tool for managing your Aspen space(s)
npm install @aspen.cloud/cmd-centerThe Admin CLI tool for managing your Aspen space(s)




* @aspen.cloud/cmd-center
* Getting Started
* Usage
* Commands
1. Add aspen via your favorite npm package manager
``sh-session
// yarn
$ yarn global add @aspen.cloud/cli
// npm
$ npm -g install @aspen.cloud/cli
`
2. Register if you do not already have an account
`sh-session`
$ aspen launch
Aspen's alpha is currently only available by invitation only, so you will need an access code. No invite, but really interested in using Aspen? Reach out to us (TODO email link).
3. Login
`sh-session`
$ aspen login
`sh-session`
$ npm install -g @aspen.cloud/cmd-center
$ aspen COMMAND
running command...
$ aspen (-v|--version|version)
@aspen.cloud/cmd-center/0.0.3 linux-x64 node-v16.5.0
$ aspen --help [COMMAND]
USAGE
$ aspen COMMAND
...
* aspen add AGENT
* [aspen dev:build [PROJECT_PATH]](#aspen-devbuild-project_path)aspen dev:init [PROJECT_PATH]
* [](#aspen-devinit-project_path)aspen dev:push [PROJECT_PATH]
* [](#aspen-devpush-project_path)aspen dev:watch [PROJECT_PATH]
* [](#aspen-devwatch-project_path)aspen help [COMMAND]
* [](#aspen-help-command)aspen home
* aspen invite [EMAIL]
* [](#aspen-invite-email)aspen launch
* aspen login
* aspen logout
* aspen run AGENT COMMAND
* aspen status
* aspen whoami
*
add an agent to your PC
`
USAGE
$ aspen add AGENT
ARGUMENTS
AGENT name of agent
`
_See code: src/commands/add.ts_
build the deployment artifacts of your agent project
`
USAGE
$ aspen dev:build [PROJECT_PATH]
ARGUMENTS
PROJECT_PATH [default: .] path to agent project
`
_See code: src/commands/dev/build.ts_
initialize an Aspen agent project
`
USAGE
$ aspen dev:init [PROJECT_PATH]
ARGUMENTS
PROJECT_PATH [default: .] path to agent project
OPTIONS
-t, --template=javascript|typescript initialize project from a template
-y, --yes answer yes/default to all setup options
`
_See code: src/commands/dev/init.ts_
deploy your project to your PC
`
USAGE
$ aspen dev:push [PROJECT_PATH]
ARGUMENTS
PROJECT_PATH [default: .] path to agent project
`
_See code: src/commands/dev/push.ts_
watch your project for file changes and deploy project on changes
`
USAGE
$ aspen dev:watch [PROJECT_PATH]
ARGUMENTS
PROJECT_PATH [default: .] path to agent project
`
_See code: src/commands/dev/watch.ts_
display help for aspen
`
USAGE
$ aspen help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
`
_See code: @oclif/plugin-help_
enter your PC
``
USAGE
$ aspen home
_See code: src/commands/home.ts_
manage and send Aspen invitations (if an EMAIL parameter is included, an invitation will be sent to that email address)
`
USAGE
$ aspen invite [EMAIL]
ARGUMENTS
EMAIL Email of invitee
EXAMPLES
$ aspen invite
You have 3/5 invitations remaining
Your invites:
jeff@amazon.com: PENDING
larry@google.com: ACCEPTED
$ aspen invite dylan@figma.com
Invite sent!
`
_See code: src/commands/invite.ts_
register your Aspen account
``
USAGE
$ aspen launch
_See code: src/commands/launch.ts_
authenticate with your PC
``
USAGE
$ aspen login
_See code: src/commands/login.ts_
logout from your PC
``
USAGE
$ aspen logout
_See code: src/commands/logout.ts_
run an action on an app written with Aspen
`
USAGE
$ aspen run AGENT COMMAND
ARGUMENTS
AGENT Name of agent
COMMAND Name of command
OPTIONS
-d, --data=data Parameters passed to agent action.
EXAMPLE
$ aspen run todos add -d "{note: 'Take out trash'}"
`
_See code: src/commands/run.ts_
check the connection status of your PC
``
USAGE
$ aspen status
_See code: src/commands/status.ts_
print the currently authenticated user
```
USAGE
$ aspen whoami
_See code: src/commands/whoami.ts_