CLI reference

Note: The Foundry CLI is not currently officially supported. Please refer to our API documentation.

Command Line Interface Reference

foundry instance-types list

This command lists all valid instance types.

USAGE
  $ foundry instance-types list [-h] [-j]

FLAGS
  -h, --help  Show CLI help.
  -j, --json  output raw json

DESCRIPTION
  list all valid instance types

EXAMPLES
  $ foundry instance-types list

foundry instances list

This command lists all instances.

USAGE
  $ foundry instances list [-h] [-j] [-p <value>] [-i <value>]

FLAGS
  -h, --help                Show CLI help.
  -i, --project-id=<value>  project id to search in, overrides current project
  -j, --json                output raw json
  -p, --project=<value>     project name to search in, overrides current project

DESCRIPTION
  list all instances

EXAMPLES
  $ foundry instances list

foundry instances restart INSTANCE

This command restarts an instance.

USAGE
  $ foundry instances restart [INSTANCE] [-i <value>]

ARGUMENTS
  INSTANCE  instance name to restart

FLAGS
  -i, --instance-id=<value>  instance id to restart

DESCRIPTION
  restart an instance

EXAMPLES
  $ foundry instances restart

foundry instances start INSTANCE

This command starts an instance.

USAGE
  $ foundry instances start [INSTANCE] [-i <value>]

ARGUMENTS
  INSTANCE  instance name to start

FLAGS
  -i, --instance-id=<value>  instance id to start

DESCRIPTION
  start an instance

EXAMPLES
  $ foundry instances start

foundry instances stop INSTANCE

This command stops an instance.

USAGE
  $ foundry instances stop [INSTANCE] [-i <value>]

ARGUMENTS
  INSTANCE  instance name to stop

FLAGS
  -i, --instance-id=<value>  instance id to stop

DESCRIPTION
  stop an instance

EXAMPLES
  $ foundry instances stop

foundry keys add

This command registers a keypair.

USAGE
  $ foundry keys add

DESCRIPTION
  register a keypair

EXAMPLES
  $ foundry keys add

foundry keys delete KEYPAIR_ID

This command removes a keypair from your Foundry account.

USAGE
  $ foundry keys delete KEYPAIR_ID

ARGUMENTS
  KEYPAIR_ID  keypair id (see `foundry keys list`)

DESCRIPTION
  remove a keypair from your Foundry account

EXAMPLES
  $ foundry keys delete

foundry keys generate

This command generates a new keypair.

USAGE
  $ foundry keys generate [-h] [-n <value>] [-p <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  name of the keypair
  -p, --path=<value>  path to save the keypair to

DESCRIPTION
  generate a new keypair

EXAMPLES
  $ foundry keys generate

foundry keys list

This command lists all keypairs in your account.

USAGE
  $ foundry keys list [-h] [-j]

FLAGS
  -h, --help  Show CLI help.
  -j, --json  output raw json

DESCRIPTION
  List all keypairs in your account

EXAMPLES
  $ foundry keys list

foundry login

This command logs you in with your Foundry credentials.

USAGE
  $ foundry login [-p <value>] [-e <value>]

FLAGS
  -e, --email=<value>     email to login with
  -p, --password=<value>  password to login with

DESCRIPTION
  login with your Foundry credentials

EXAMPLES
  $ foundry login
  $ foundry login -e [e-mail] -p password

foundry logout

This command logs you out of Foundry.

USAGE
  $ foundry logout

DESCRIPTION
  logout of Foundry

EXAMPLES
  $ foundry logout

foundry projects list

This command lists all projects in your organization.

USAGE
  $ foundry projects list [-h] [-j]

FLAGS
  -h, --help  Show CLI help.
  -j, --json  output raw json

DESCRIPTION
  list all projects in your organization

EXAMPLES
  $ foundry projects list

foundry projects set PROJECT

This command sets the current working project.

USAGE
  $ foundry projects set [PROJECT] [-h] [-i <value>]

ARGUMENTS
  PROJECT  project name to set as current working project

FLAGS
  -h, --help        Show CLI help.
  -i, --id=<value>  project id to set as current working project

DESCRIPTION
  set the current working project

EXAMPLES
  $ foundry projects set

foundry whoami

This command displays the current user, if logged in.

USAGE
  $ foundry whoami

DESCRIPTION
  display the current user, if logged in

EXAMPLES
  $ foundry whoami

foundry autocomplete SHELL

This command displays autocomplete installation instructions.

USAGE
  $ foundry autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ foundry autocomplete

  $ foundry autocomplete bash

  $ foundry autocomplete zsh

  $ foundry autocomplete --refresh-cache

foundry help COMMANDS

This command displays help information.

USAGE
  $ foundry help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for foundry.