@codeyourfuture/cli

Command line tools for CodeYourFuture.

Installation

$ npm install --global @codeyourfuture/cli

Usage

$ cyf --help
Usage: cyf [options] [command]

Command line tools for CodeYourFuture

Options:
  -V, --version        output the version number
  -c, --config <file>  config file location (defaults to ~/.cyf.json)
  --dry-run            parse arguments without running the command
  -h, --help           display help for command

Commands:
  allow-ip [options]   allow your IP to access a security group
  help [command]       display help for command

Configuration

Config file

Some configuration is stored in a file, defaulting to ~/.cyf.json. This is created automatically, if it does not exist, as an empty JSON file.

{
  "allowIpPort": 0,
  "allowIpSecurityGroup": ""
}

• allowIpPort: the port used by the allow-ip command (can be overridden with the --port CLI flag)
• allowIpSecurityGroup: the port used by the allow-ip command (can be overridden with the --security-group CLI flag)
• awsProfile: the profile used for AWS credentials (can be overridden with the AWS_PROFILE environment variable)
• awsRegion: the region used for AWS operations (can be overridden with the AWS_REGION environment variable)

Environment variables

The following environment variables are supported:

• AWS_ENDPOINT: the endpoint used for AWS operations (note primarily used for testing against Localstack)
• AWS_PROFILE: the profile used for AWS credentials
• AWS_REGION: the region used for AWS operations

Debugging

The CYF CLI uses debug for low-level logs; enable by setting an environment variable e.g. DEBUG=cyf:* when running the CLI.