pilot-framework

• Usage
• Commands

Usage

$ npm install -g @pilot-framework/pilot
$ pilot COMMAND
running command...
$ pilot (-v|--version|version)
@pilot-framework/pilot/0.1.7 linux-x64 node-v15.6.0
$ pilot --help [COMMAND]
USAGE
  $ pilot COMMAND
...

Commands

• pilot configure
• pilot connect
• pilot destroy [APP]
• pilot help [COMMAND]
• pilot init
• pilot invite
• pilot new TYPE
• pilot server [FILE]
• pilot setup
• pilot ui [FILE]
• pilot up [PROJECT] [PATH]

pilot configure

Configure remote Waypoint Server with credentials for selected cloud provider.

USAGE
  $ pilot configure

OPTIONS
  -h, --help             show CLI help
  -p, --project=project  Project ID for GCP Project that the service account and IAM role will be created for
  --aws                  Configure server with AWS Pilot IAM credentials
  --gcp                  Configure server with GCP Pilot IAM credentials

DESCRIPTION
  This typically only needs to be run once for each provider.

See code: src/commands/configure.ts

pilot connect

Used to set the connection context to a Waypoint server from an invite

USAGE
  $ pilot connect

OPTIONS
  -h, --help           show CLI help
  -v, --verify         Verify connection with the Waypoint server
  --address=address    Address of server
  --provider=provider  Pilot server cloud provider
  --token=token        Authentication token of server

See code: src/commands/connect.ts

pilot destroy [APP]

Destroys all deployments and releases of an application

USAGE
  $ pilot destroy [APP]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/destroy.ts

pilot help [COMMAND]

display help for pilot

USAGE
  $ pilot help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

pilot init

Scaffolds Pilot's metadata information in ~/.pilot

USAGE
  $ pilot init

OPTIONS
  -h, --help               show CLI help
  --gcp-policy=gcp-policy  Specify a path to a CSV file for granular permissions

See code: src/commands/init.ts

pilot invite

Creates an invite string that can be sent to team members

USAGE
  $ pilot invite

OPTIONS
  -h, --help  show CLI help

See code: src/commands/invite.ts

pilot new TYPE

Initializes a project or application to be used with Pilot

USAGE
  $ pilot new TYPE

ARGUMENTS
  TYPE  (project|app) the type you are trying to initialize (project or app)

OPTIONS
  -b, --bare  Generates Waypoint's template project hcl file.
  -h, --help  show CLI help

See code: src/commands/new.ts

pilot server [FILE]

Used to interact with the remote management server

USAGE
  $ pilot server [FILE]

OPTIONS
  -d, --destroy  Teardown the remote management server with its provisioned resources
  -h, --help     show CLI help
  -l, --list     List existing Waypoint Runner configuration
  -s, --ssh      SSH to remote management server
  --db           Provides database connection information

See code: src/commands/server.ts

pilot setup

Sets up Pilot Framework environment

USAGE
  $ pilot setup

OPTIONS
  -d, --dev   Provision Waypoint server using our experimental Docker image. Not guaranteed to work.
  -h, --help  show CLI help
  --aws       Provision Waypoint server on AWS EC2 using Pilot's Docker image.

  --bare      Provision Waypoint server using the default Waypoint Docker image.
              WARNING: you will not have access to Pilot's custom plugins.

  --gcp       Provision Waypoint server on GCP Compute Engine using Pilot's Docker image.

See code: src/commands/setup.ts

pilot ui [FILE]

Opens the Waypoint UI on the default browser

USAGE
  $ pilot ui [FILE]

OPTIONS
  -a, --authenticate  Automatically log in to Waypoint UI
  -h, --help          show CLI help

See code: src/commands/ui.ts

pilot up [PROJECT] [PATH]

Deploys your project

USAGE
  $ pilot up [PROJECT] [PATH]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/up.ts