github.com/architect-team/architect-cli @v1.44.1

<img width="320" alt="Architect Logo" src="https://cdn.architect.io/logo/horizontal.png"/>

Self-service cloud environments for everyone. Achieve deployment, networking, and security automation all at once with Architect.

Architect is the world's first DevOps-as-a-Service toolset designed to help democratize environment provisioning for engineers. With Architect, anyone can deploy any service, anywhere, for any reason with the push of a button.

Our unique approach to continuous delivery is powered by an embedded dependency resolver. By simply asserting your microservice dependenies, Architect is able to build a graph of your application and deploy the entire stack to your favorite cloud provider.

Architect's CLI, which provides the full developer experience needed to create components and operate local environments, is fully open-source. The CLI can deploy components locally using docker-compose, enrich the deployments with components found in Architect's Cloud registry, and allows developers to publish their own components to the registry both publicly and privately for free.

Requirements

• Docker must be installed
• Node.js v14 or higher must be installed

Usage

$ npm install -g @architect-io/cli
$ architect COMMAND
running command...
$ architect (--version)
@architect-io/cli/1.44.1-rc.1 linux-x64 node-v16.20.2
$ architect --help [COMMAND]
USAGE
  $ architect COMMAND
...

Commands

• architect autocomplete [SHELL]
• architect clusters [QUERY]
• architect clusters:create [CLUSTER]
• architect clusters:destroy [CLUSTER]
• architect components:versions [COMPONENT_NAME]
• architect config:get OPTION
• architect config:set OPTION VALUE
• architect config:view
• architect deploy [CONFIGS_OR_COMPONENTS]
• architect destroy
• architect dev [CONFIGS_OR_COMPONENTS]
• architect dev:list
• architect dev:restart [SERVICES]
• architect dev:stop [NAME]
• architect doctor
• architect environments:create [ENVIRONMENT]
• architect environments:destroy [ENVIRONMENT]
• architect environments:ingresses [ENVIRONMENT]
• architect exec [RESOURCE] [FLAGS] -- [COMMAND]
• architect help [COMMAND]
• architect init [NAME]
• architect link [COMPONENTPATH]
• architect link:list
• architect login
• architect logout
• architect logs [RESOURCE]
• architect port-forward [RESOURCE] [FLAGS]
• architect register [COMPONENT]
• architect scale [SERVICE]
• architect secrets:download SECRETS_FILE
• architect secrets:upload SECRETS_FILE
• architect task COMPONENT TASK
• architect unlink [COMPONENTPATHORNAME]

architect autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ architect autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

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

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ architect autocomplete

  $ architect autocomplete bash

  $ architect autocomplete zsh

  $ architect autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

architect clusters [QUERY]

Search for clusters on Architect Cloud

USAGE
  $ architect clusters [QUERY] [-a <value>]

ARGUMENTS
  QUERY  Search query used to filter results

FLAGS
  -a, --account=<value>  Architect account

DESCRIPTION
  Search for clusters on Architect Cloud

ALIASES
  $ architect cluster
  $ architect cluster:search
  $ architect cluster:list
  $ architect clusters:search
  $ architect clusters:list

EXAMPLES
  $ architect clusters

  $ architect clusters --account=myaccount mycluster

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

architect clusters:create [CLUSTER]

Register a new cluster with Architect Cloud

USAGE
  $ architect clusters:create [CLUSTER] [-a <value>] [--auto-approve <value>] [-t AGENT|agent] [-k <value> | -h
    <value>] [--flag <value>]

ARGUMENTS
  CLUSTER  Name to give the cluster

FLAGS
  -a, --account=<value>     Architect account
  -h, --host=<value>
  -k, --kubeconfig=<value>  [default: ~/.kube/config]
  -t, --type=<option>       <options: AGENT|agent>
  --auto-approve=<value>
  --flag=<value>...         [default: ]

DESCRIPTION
  Register a new cluster with Architect Cloud

ALIASES
  $ architect clusters:register
  $ architect cluster:create

EXAMPLES
  $ architect clusters:create --account=myaccount

  $ architect clusters:register --account=myaccount --kubeconfig=~/.kube/config --auto-approve

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

architect clusters:destroy [CLUSTER]

Deregister a cluster from Architect

USAGE
  $ architect clusters:destroy [CLUSTER] [-a <value>] [--auto-approve <value>] [-f <value>]

ARGUMENTS
  CLUSTER  Name of the cluster to deregister

FLAGS
  -a, --account=<value>   Architect account
  -f, --force=<value>     Force the deletion even if the cluster is not empty
  --auto-approve=<value>  Automatically apply the changes

DESCRIPTION
  Deregister a cluster from Architect

ALIASES
  $ architect clusters:deregister
  $ architect cluster:destroy

EXAMPLES
  $ architect cluster:destroy --account=myaccount architect

  $ architect clusters:deregister --account=myaccount --auto-approve --force architect

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

architect components:versions [COMPONENT_NAME]

Search component versions of a particular component

USAGE
  $ architect components:versions [COMPONENT_NAME] [-a <value>]

FLAGS
  -a, --account=<value>  Architect account

DESCRIPTION
  Search component versions of a particular component

ALIASES
  $ architect component:versions
  $ architect component:version

EXAMPLES
  $ architect component:versions mycomponent

  $ architect component:versions --account=myaccount mycomponent

See code: src/commands/components/versions.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

DESCRIPTION
  Get the value of a CLI config option

EXAMPLES
  $ architect config:get log_level

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

DESCRIPTION
  Set a new value for a CLI configuration option

EXAMPLES
  $ architect config:set log_level info

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

architect config:view

View all the CLI configuration settings

USAGE
  $ architect config:view

DESCRIPTION
  View all the CLI configuration settings

ALIASES
  $ architect config

EXAMPLES
  $ architect config

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

architect deploy [CONFIGS_OR_COMPONENTS]

Create a deploy job on Architect Cloud

USAGE
  $ architect deploy [CONFIGS_OR_COMPONENTS] [--auto-approve <value> | -o <value> | ] [-a <value>] [-e
    <value>] [--production <value> ] [-d <value> ] [--secret-file <value>] [-s <value>] [--deletion-protection <value> |
    ] [-r <value>] [--browser <value>] [--arg <value>] [--architecture <value>] [--cache-directory <value>]

ARGUMENTS
  CONFIGS_OR_COMPONENTS  Path to an architect.yml file or component `component:latest`. Multiple components are
                         accepted.

FLAGS
  -a, --account=<value>          Architect account
  -d, --detached=<value>         Run in detached mode
  -e, --environment=<value>      Architect environment
  -o, --compose-file=<value>     Path where the compose file should be written to
  -r, --recursive=<value>        [default: true] Toggle to automatically deploy all dependencies
  -s, --secret=<value>...        [default: ] An individual secret key and value in the form SECRET_KEY=SECRET_VALUE
  --architecture=<value>...      [default: amd64] Architecture(s) to target for Docker image builds
  --arg=<value>...               Build arg(s) to pass to docker build
  --auto-approve=<value>         Automatically approve the deployment without a review step. Used for debugging and CI
                                 flows.
  --browser=<value>              [default: true] Automatically open urls in the browser for local deployments
  --cache-directory=<value>      Directory to write build cache to. Do not use in Github Actions:
                                 https://docs.architect.io/deployments/automated-previews/#caching-between-workflow-runs
  --deletion-protection=<value>  [default: true] Toggle for deletion protection on deployments
  --production=<value>           Please use --environment.
  --secret-file=<value>...       [default: ] Path of secrets file

DESCRIPTION
  Create a deploy job on Architect Cloud

EXAMPLES
  $ architect deploy mycomponent:latest

  $ architect deploy ./myfolder/architect.yml --secret-file=./mysecrets.yml --environment=myenvironment --account=myaccount --auto-approve

See code: src/commands/deploy.ts

architect destroy

Destroy components from an environment

USAGE
  $ architect destroy [--auto-approve <value> |  | ] [-a <value>] [-e <value>] [-c <value>]

FLAGS
  -a, --account=<value>        Architect account
  -c, --components=<value>...  Component(s) to destroy
  -e, --environment=<value>    Architect environment
  --auto-approve=<value>       Automatically approve the deployment without a review step. Used for debugging and CI
                               flows.

DESCRIPTION
  Destroy components from an environment

EXAMPLES
  $ architect destroy --account=myaccount --auto-approve

  $ architect destroy --account=myaccount --environment=myenvironment --auto-approve

See code: src/commands/destroy.ts

architect dev [CONFIGS_OR_COMPONENTS]

Run your stack locally

``` USAGE $ architect dev [CONFIGS_OR_COMPONENTS] [-a ] [-o | -e ] [--secret-file ] [-s ] [-r ] [--browser ] [--port ] [-d ] [--wait-timeout ] [--debug ] [--arg ] [--ssl ] [--overlay ]

ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component component:latest. Multiple components are accepted.

FLAGS -a, --account= Architect account -d, --detached= Run in detached mode -e, --environment= Name of environment created locally during dev. This is only local and will not reflect in your architect account -o, --compose-file= Path where the compose file should be written to