architect-cli v0.3.4

architect-cli

Command-line interface for Architect.io

• Usage
• Commands

Usage

$ npm install -g architect-cli
$ architect COMMAND
running command...
$ architect (-v|--version|version)
architect-cli/0.3.4 linux-x64 node-v12.14.0
$ architect --help [COMMAND]
USAGE
  $ architect COMMAND
...

Commands

• architect build
• architect config:get OPTION
• architect config:set OPTION VALUE
• architect config:view
• architect deploy [ENVIRONMENT_CONFIG]
• architect environments [QUERY]
• architect environments:create [NAME]
• architect environments:destroy NAMESPACED_ENVIRONMENT
• architect environments:update NAMESPACED_ENVIRONMENT
• architect help [COMMAND]
• architect init [NAME]
• architect install [SERVICE_REF]
• architect login
• architect logout
• architect push
• architect services [QUERY]
• architect uninstall DEPENDENCY_NAME

architect build

Build an Architect-ready Docker image for a service

USAGE
  $ architect build

OPTIONS
  -e, --environment=environment  Path to an environment config including local services to build
  -h, --help                     show CLI help
  -s, --services=services        Path to a service to build
  -t, --tag=tag                  [default: latest] Tag to give to the new Docker image(s)

See code: src/commands/build.ts

architect config:get OPTION

Get the value of a CLI config option

USAGE
  $ architect config:get OPTION

ARGUMENTS
  OPTION  Name of a config option

OPTIONS
  -h, --help  show CLI help

See code: src/commands/config/get.ts

architect config:set OPTION VALUE

Set a new value for a CLI configuration option

USAGE
  $ architect config:set OPTION VALUE

ARGUMENTS
  OPTION  Name of a config option
  VALUE   New value to assign to a config option

OPTIONS
  -h, --help  show CLI help

See code: src/commands/config/set.ts

architect config:view

View all the CLI configuration settings

USAGE
  $ architect config:view

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ architect config

See code: src/commands/config/view.ts

architect deploy [ENVIRONMENT_CONFIG]

Create a deploy job on Architect Cloud or run stacks locally

USAGE
  $ architect deploy [ENVIRONMENT_CONFIG]

ARGUMENTS
  ENVIRONMENT_CONFIG  Path to an environment config file

OPTIONS
  -a, --account=account            Account to deploy the services with
  -e, --environment=environment    Environment to deploy the services to
  -h, --help                       show CLI help
  -l, --local                      Deploy the stack locally instead of via Architect Cloud

  -o, --compose_file=compose_file  [default: /tmp/architect-deployment-1577733814132.json] Path where the compose file
                                   should be written to

  --auto_approve

See code: src/commands/deploy.ts

architect environments [QUERY]

List environments you have access to

USAGE
  $ architect environments [QUERY]

ARGUMENTS
  QUERY  Search term used to filter the results

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ architect environments
  $ architect envs
  $ architect env
  $ architect environments:list
  $ architect envs:list
  $ architect env:list

See code: src/commands/environments/index.ts

architect environments:create [NAME]

Register a new environment with Architect Cloud

USAGE
  $ architect environments:create [NAME]

ARGUMENTS
  NAME  Name to give the environment

OPTIONS
  -a, --account=account
  -c, --config_file=config_file
  -h, --help                                       show CLI help
  -h, --host=host
  -k, --kubeconfig=kubeconfig                      [default: ~/.kube/config]
  -n, --namespace=namespace
  -t, --type=kubernetes                            [default: kubernetes]
  --cluster_ca_certificate=cluster_ca_certificate  File path of cluster_ca_certificate
  --service_token=service_token                    Service token

ALIASES
  $ architect environment:create
  $ architect envs:create
  $ architect env:create

See code: src/commands/environments/create.ts

architect environments:destroy NAMESPACED_ENVIRONMENT

Destroy an environment

USAGE
  $ architect environments:destroy NAMESPACED_ENVIRONMENT

ARGUMENTS
  NAMESPACED_ENVIRONMENT  Name of the environment to destroy

OPTIONS
  -a, --auto_approve  Automatically apply the changes without reviewing the diff
  -f, --force         Force the deletion even if the environment is not empty
  -h, --help          show CLI help

ALIASES
  $ architect environment:destroy
  $ architect envs:destroy
  $ architect env:destroy

See code: src/commands/environments/destroy.ts

architect environments:update NAMESPACED_ENVIRONMENT

Update an environments configuration

USAGE
  $ architect environments:update NAMESPACED_ENVIRONMENT

ARGUMENTS
  NAMESPACED_ENVIRONMENT  Name of the environment to update

OPTIONS
  -c, --config_file=config_file                        Path to an environment configuration file to use
  -h, --help                                           show CLI help
  -k, --cluster_ca_certificate=cluster_ca_certificate  File path of cluster_ca_certificate
  -t, --service_token=service_token                    Service token
  --host=host

ALIASES
  $ architect environment:update
  $ architect envs:update
  $ architect env:update

See code: src/commands/environments/update.ts

architect help [COMMAND]

display help for architect

USAGE
  $ architect help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

architect init [NAME]

Generate an Architect service configuration file

USAGE
  $ architect init [NAME]

OPTIONS
  -d, --description=description  Written description of the service and its function
  -h, --help                     show CLI help
  -k, --keywords=keywords        Comma-separated list of keywords used to discover the service
  -l, --language=language        The language the service is written in
  -o, --output=output            Directory to write config file to

EXAMPLE
  $ architect hello
  ? name: architect/test-service
  ? description: Test service
  ? keywords (comma-separated): test,microservice
  ? author: architect

See code: src/commands/init.ts

architect install [SERVICE_REF]

Install services and generate the corresponding client libraries

USAGE
  $ architect install [SERVICE_REF]

ARGUMENTS
  SERVICE_REF  Name of or path to the service to install

OPTIONS
  -e, --environment=environment  Path to an environment config including local services to build
  -h, --help                     show CLI help
  -s, --services=services        Path to a service to build

See code: src/commands/install.ts

architect login

Login to the Architect Cloud platform

USAGE
  $ architect login

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  Password
  -u, --username=username  Username

See code: src/commands/login.ts

architect logout

Logout from the Architect registry

USAGE
  $ architect logout

OPTIONS
  -h, --help  show CLI help

See code: src/commands/logout.ts

architect push

Push service(s) to a registry

USAGE
  $ architect push

OPTIONS
  -e, --environment=environment  Path to an environment config including local services to build
  -h, --help                     show CLI help
  -s, --services=services        Path to a service to build
  -t, --tag=tag                  [default: latest] Tag to give to the new Docker image(s)

See code: src/commands/push.ts

architect services [QUERY]

Search for services on Architect Cloud

USAGE
  $ architect services [QUERY]

ARGUMENTS
  QUERY  Search query used to filter results

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ architect services
  $ architect services:search

See code: src/commands/services/index.ts

architect uninstall DEPENDENCY_NAME

Uninstall a dependency from the current service

USAGE
  $ architect uninstall DEPENDENCY_NAME

ARGUMENTS
  DEPENDENCY_NAME  Name of the dependency to remove

OPTIONS
  -h, --help             show CLI help
  -s, --service=service  Path to service root

See code: src/commands/uninstall.ts