cyclic-cli

Cyclic cli: your plumbing for the cloud

• Usage
• Commands
• Development Notes

Usage

$ npm install -g cyclic-cli
$ cyclic COMMAND
running command...
$ cyclic (-v|--version|version)
cyclic-cli/0.0.14 darwin-x64 node-v14.15.5
$ cyclic --help [COMMAND]
USAGE
  $ cyclic COMMAND
...

Commands

• cyclic bootstrap
• cyclic help [COMMAND]
• cyclic init-app
• cyclic login
• cyclic token

cyclic bootstrap

Will create CyclicAppManagementStack stack in your AWS account.

USAGE
  $ cyclic bootstrap

OPTIONS
  -h, --help             show CLI help
  -p, --profile=profile  aws credential profile (defaults to default)

EXAMPLE
  $ cyclic bootstrap --profile $PROFILE
  * Checking AWS account for bootstrapping
  * Creating CfN stack: CyclicAppManagementStack
  * Provisioning ...

See code: src/commands/bootstrap.ts

cyclic help [COMMAND]

display help for cyclic

USAGE
  $ cyclic help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cyclic init-app

Will initialize the an application in the AWS account you are credentialed against.

USAGE
  $ cyclic init-app

OPTIONS
  -a, --api=api          url to base of cyclic api for requests (default https://api.cyclic.sh/v1)
  -d, --debug            print debugging output
  -h, --help             show CLI help
  -n, --name=name        application name (defaults to random words)
  -p, --profile=profile  aws credential profile (defaults to default)

EXAMPLE
  $ cyclic init-app --name $APP_NAME --profile $PROFILE
  * Checking AWS account for bootstrapping
  * Checking AWS account for required roles
  * Creating Cyclic App: $APP_NAME
  * Provisioning AWS pipeline resources

See code: src/commands/init-app.ts

cyclic login

Will log you into the Cyclic CLI and allow you to make authenticated api calls.

USAGE
  $ cyclic login

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

EXAMPLE
  $ cyclic login

See code: src/commands/login.ts

cyclic token

describe the command here

USAGE
  $ cyclic token

OPTIONS
  -f, --file=file  file name and path of auth file
  -h, --help       show CLI help

See code: src/commands/token.ts

Development Notes

Run Locally

./bin/run init-app

Publish

There is a github action that takes care of that. Just bump version.

npm version [major | minor | patch]