@aspen.cloud/cmd-center

The Admin CLI tool for managing your Aspen space(s)

• @aspen.cloud/cmd-center
• Getting Started
• Usage
• Commands

Getting Started

1. Add aspen via your favorite npm package manager

// yarn
$ yarn global add @aspen.cloud/cli

// npm
$ npm -g install @aspen.cloud/cli

2. Register if you do not already have an account

$ 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

$ aspen login

Usage

$ 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
...

Commands

• aspen add AGENT
• aspen dev:build [PROJECT_PATH]
• aspen dev:init [PROJECT_PATH]
• aspen dev:push [PROJECT_PATH]
• aspen dev:watch [PROJECT_PATH]
• aspen help [COMMAND]
• aspen home
• aspen invite [EMAIL]
• aspen launch
• aspen login
• aspen logout
• aspen run AGENT COMMAND
• aspen status
• aspen whoami

aspen add AGENT

add an agent to your PC

USAGE
  $ aspen add AGENT

ARGUMENTS
  AGENT  name of agent

See code: src/commands/add.ts

aspen dev:build [PROJECT_PATH]

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

aspen dev:init [PROJECT_PATH]

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

aspen dev:push [PROJECT_PATH]

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

aspen dev:watch [PROJECT_PATH]

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

aspen help [COMMAND]

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

aspen home

enter your PC

USAGE
  $ aspen home

See code: src/commands/home.ts

aspen invite [EMAIL]

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:
  [e-mail]: PENDING
  [e-mail]: ACCEPTED

  $ aspen invite [e-mail]
  Invite sent!

See code: src/commands/invite.ts

aspen launch

register your Aspen account

USAGE
  $ aspen launch

See code: src/commands/launch.ts

aspen login

authenticate with your PC

USAGE
  $ aspen login

See code: src/commands/login.ts

aspen logout

logout from your PC

USAGE
  $ aspen logout

See code: src/commands/logout.ts

aspen run AGENT COMMAND

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

aspen status

check the connection status of your PC

USAGE
  $ aspen status

See code: src/commands/status.ts

aspen whoami

print the currently authenticated user

USAGE
  $ aspen whoami

See code: src/commands/whoami.ts