Architect.io Docs
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
v12
or higher must be installed
Usage
$ npm install -g @architect-io/cli$ architect COMMANDrunning command...$ architect (--version)@architect-io/cli/1.24.0-rc.1 linux-x64 node-v16.16.0$ architect --help [COMMAND]USAGE $ architect COMMAND...
Commands
architect autocomplete [SHELL]
architect c:register [COMPONENT]
architect c:validate [CONFIGS_OR_COMPONENTS]
architect comp:register [COMPONENT]
architect comp:validate [CONFIGS_OR_COMPONENTS]
architect component:register [COMPONENT]
architect component:search [QUERY]
architect component:validate [CONFIGS_OR_COMPONENTS]
architect component:version [COMPONENT_NAME]
architect component:versions [COMPONENT_NAME]
architect components [QUERY]
architect components:register [COMPONENT]
architect components:search [QUERY]
architect components:validate [CONFIGS_OR_COMPONENTS]
architect components:versions [COMPONENT_NAME]
architect config
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 doctor
architect env [QUERY]
architect env:create [ENVIRONMENT]
architect env:deregister [ENVIRONMENT]
architect env:destroy [ENVIRONMENT]
architect env:search [QUERY]
architect environment:create [ENVIRONMENT]
architect environment:deregister [ENVIRONMENT]
architect environment:destroy [ENVIRONMENT]
architect environments [QUERY]
architect environments:create [ENVIRONMENT]
architect environments:destroy [ENVIRONMENT]
architect environments:search [QUERY]
architect envs [QUERY]
architect envs:create [ENVIRONMENT]
architect envs:destroy [ENVIRONMENT]
architect envs:search [QUERY]
architect exec [RESOURCE] [FLAGS] -- [COMMAND]
architect help [COMMAND]
architect init
architect link [COMPONENTPATH]
architect link:list
architect login
architect logout
architect logs [RESOURCE]
architect platform [QUERY]
architect platform:create [PLATFORM]
architect platform:destroy [PLATFORM]
architect platform:search [QUERY]
architect platforms [QUERY]
architect platforms:create [PLATFORM]
architect platforms:deregister [PLATFORM]
architect platforms:destroy [PLATFORM]
architect platforms:register [PLATFORM]
architect platforms:search [QUERY]
architect register [COMPONENT]
architect secrets SECRETS_FILE
architect secrets/get SECRETS_FILE
architect secrets:download SECRETS_FILE
architect secrets:set SECRETS_FILE
architect secrets:upload SECRETS_FILE
architect task COMPONENT TASK
architect task:exec COMPONENT TASK
architect unlink [COMPONENTPATHORNAME]
architect validate [CONFIGS_OR_COMPONENTS]
architect whoami
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 c:register [COMPONENT]
Register a new Component with Architect Cloud
USAGE $ architect c:register [COMPONENT] [-a <value>] [--arg <value>] [-t <value> | ] [--architecture <value>] [--cache-directory <value>]
ARGUMENTS COMPONENT [default: ./] Path to a component to register
FLAGS -a, --account=<value> Architect account -t, --tag=<value> [default: latest] Tag to give to the new component --architecture=<value>... [default: amd64] Architecture(s) to target for Docker image builds --arg=<value>... Build arg(s) to pass to docker build --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
DESCRIPTION Register a new Component with Architect Cloud
ALIASES $ architect component:register $ architect components:register $ architect c:register $ architect comp:register
EXAMPLES $ architect register
$ architect register -t latest
$ architect register -a myaccount -t latest ./architect.yml ../myothercomponent/architect.yml
$ architect register -a myaccount -t latest --arg NODE_ENV=dev ./architect.yml
architect c:validate [CONFIGS_OR_COMPONENTS]
Validate that an architect.yml is syntactically correct.
USAGE $ architect c:validate [CONFIGS_OR_COMPONENTS]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
DESCRIPTION Validate that an architect.yml is syntactically correct.
ALIASES $ architect component:validate $ architect components:validate $ architect c:validate $ architect comp:validate $ architect validate
EXAMPLES $ architect validate .
$ architect validate ../mycomponent/architect.yml ../myothercomponent/architect.yml
architect comp:register [COMPONENT]
Register a new Component with Architect Cloud
USAGE $ architect comp:register [COMPONENT] [-a <value>] [--arg <value>] [-t <value> | ] [--architecture <value>] [--cache-directory <value>]
ARGUMENTS COMPONENT [default: ./] Path to a component to register
FLAGS -a, --account=<value> Architect account -t, --tag=<value> [default: latest] Tag to give to the new component --architecture=<value>... [default: amd64] Architecture(s) to target for Docker image builds --arg=<value>... Build arg(s) to pass to docker build --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
DESCRIPTION Register a new Component with Architect Cloud
ALIASES $ architect component:register $ architect components:register $ architect c:register $ architect comp:register
EXAMPLES $ architect register
$ architect register -t latest
$ architect register -a myaccount -t latest ./architect.yml ../myothercomponent/architect.yml
$ architect register -a myaccount -t latest --arg NODE_ENV=dev ./architect.yml
architect comp:validate [CONFIGS_OR_COMPONENTS]
Validate that an architect.yml is syntactically correct.
USAGE $ architect comp:validate [CONFIGS_OR_COMPONENTS]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
DESCRIPTION Validate that an architect.yml is syntactically correct.
ALIASES $ architect component:validate $ architect components:validate $ architect c:validate $ architect comp:validate $ architect validate
EXAMPLES $ architect validate .
$ architect validate ../mycomponent/architect.yml ../myothercomponent/architect.yml
architect component:register [COMPONENT]
Register a new Component with Architect Cloud
USAGE $ architect component:register [COMPONENT] [-a <value>] [--arg <value>] [-t <value> | ] [--architecture <value>] [--cache-directory <value>]
ARGUMENTS COMPONENT [default: ./] Path to a component to register
FLAGS -a, --account=<value> Architect account -t, --tag=<value> [default: latest] Tag to give to the new component --architecture=<value>... [default: amd64] Architecture(s) to target for Docker image builds --arg=<value>... Build arg(s) to pass to docker build --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
DESCRIPTION Register a new Component with Architect Cloud
ALIASES $ architect component:register $ architect components:register $ architect c:register $ architect comp:register
EXAMPLES $ architect register
$ architect register -t latest
$ architect register -a myaccount -t latest ./architect.yml ../myothercomponent/architect.yml
$ architect register -a myaccount -t latest --arg NODE_ENV=dev ./architect.yml
architect component:search [QUERY]
Search components you have access to
USAGE $ architect component:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search components you have access to
ALIASES $ architect components $ architect components:search $ architect component:search $ architect component:search
EXAMPLES $ architect components
$ architect components --account=myaccount
$ architect components mycomponent
architect component:validate [CONFIGS_OR_COMPONENTS]
Validate that an architect.yml is syntactically correct.
USAGE $ architect component:validate [CONFIGS_OR_COMPONENTS]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
DESCRIPTION Validate that an architect.yml is syntactically correct.
ALIASES $ architect component:validate $ architect components:validate $ architect c:validate $ architect comp:validate $ architect validate
EXAMPLES $ architect validate .
$ architect validate ../mycomponent/architect.yml ../myothercomponent/architect.yml
architect component:version [COMPONENT_NAME]
Search component versions of a particular component
USAGE $ architect component:version [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
architect component:versions [COMPONENT_NAME]
Search component versions of a particular component
USAGE $ architect component: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
architect components [QUERY]
Search components you have access to
USAGE $ architect components [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search components you have access to
ALIASES $ architect components $ architect components:search $ architect component:search $ architect component:search
EXAMPLES $ architect components
$ architect components --account=myaccount
$ architect components mycomponent
See code: src/commands/components/index.ts
architect components:register [COMPONENT]
Register a new Component with Architect Cloud
USAGE $ architect components:register [COMPONENT] [-a <value>] [--arg <value>] [-t <value> | ] [--architecture <value>] [--cache-directory <value>]
ARGUMENTS COMPONENT [default: ./] Path to a component to register
FLAGS -a, --account=<value> Architect account -t, --tag=<value> [default: latest] Tag to give to the new component --architecture=<value>... [default: amd64] Architecture(s) to target for Docker image builds --arg=<value>... Build arg(s) to pass to docker build --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
DESCRIPTION Register a new Component with Architect Cloud
ALIASES $ architect component:register $ architect components:register $ architect c:register $ architect comp:register
EXAMPLES $ architect register
$ architect register -t latest
$ architect register -a myaccount -t latest ./architect.yml ../myothercomponent/architect.yml
$ architect register -a myaccount -t latest --arg NODE_ENV=dev ./architect.yml
architect components:search [QUERY]
Search components you have access to
USAGE $ architect components:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search components you have access to
ALIASES $ architect components $ architect components:search $ architect component:search $ architect component:search
EXAMPLES $ architect components
$ architect components --account=myaccount
$ architect components mycomponent
architect components:validate [CONFIGS_OR_COMPONENTS]
Validate that an architect.yml is syntactically correct.
USAGE $ architect components:validate [CONFIGS_OR_COMPONENTS]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
DESCRIPTION Validate that an architect.yml is syntactically correct.
ALIASES $ architect component:validate $ architect components:validate $ architect c:validate $ architect comp:validate $ architect validate
EXAMPLES $ architect validate .
$ architect validate ../mycomponent/architect.yml ../myothercomponent/architect.yml
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
View all the CLI configuration settings
USAGE $ architect config
DESCRIPTION View all the CLI configuration settings
ALIASES $ architect config
EXAMPLES $ architect config
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 | -o <value> | ] [-a <value>] [-e <value>] [--production ] [-d ] [-i <value>] [--secret-file <value>] [-s <value>] [--deletion-protection | ] [-r] [--browser]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
FLAGS -a, --account=<value> Architect account -d, --detached Run in detached mode -e, --environment=<value> Architect environment -i, --interface=<value>... [default: ] Component interfaces -o, --compose-file=<value> Path where the compose file should be written to -r, --[no-]recursive [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 --auto-approve Automatically approve the deployment without a review step. Used for debugging and CI flows. --[no-]browser [default: true] Automatically open urls in the browser for local deployments --[no-]deletion-protection [default: true] Toggle for deletion protection on deployments --production [deprecated] Please use --environment. --secret-file=<value>... [default: ] Path of secrets file
DESCRIPTION Create a deploy job on Architect Cloud
EXAMPLES $ architect deploy myaccount/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 | | ] [-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 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 <value>] [-o <value> | -e <value> | | | ] [-i <value>] [--secret-file <value>] [-s <value>] [-r] [--browser] [--port <value>] [-d] [--debug <value>] [--arg <value>]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
FLAGS -a, --account=<value> Architect account -d, --detached Run in detached mode -e, --environment=<value> Architect environment -i, --interface=<value>... [default: ] Component interfaces -o, --compose-file=<value> Path where the compose file should be written to -r, --[no-]recursive [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 --arg=<value>... Build arg(s) to pass to docker build --[no-]browser [default: true] Automatically open urls in the browser for local deployments --debug=<value> [default: true] [default: true] Turn debug mode on (true) or off (false) --port=<value> [default: 80] [default: 80] Port for the gateway --secret-file=<value>... [default: ] Path of secrets file
DESCRIPTION Run your stack locally
EXAMPLES $ architect dev ./mycomponent/architect.yml
$ architect dev --port=81 --no-browser --debug=true --secret-file=./mycomponent/mysecrets.yml ./mycomponent/architect.yml
See code: src/commands/dev.ts
architect doctor
Get debugging information for troubleshooting
USAGE $ architect doctor
FLAGS -o, --output=<value> Choose a file to output the debug information to
DESCRIPTION Get debugging information for troubleshooting
EXAMPLES $ architect doctor
$ architect doctor -o ./myoutput.yml
See code: src/commands/doctor.ts
architect env [QUERY]
Search environments you have access to
USAGE $ architect env [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
architect env:create [ENVIRONMENT]
Register a new environment with Architect Cloud
USAGE $ architect env:create [ENVIRONMENT] [-a <value>] [--platform <value>] [--description <value>] [--ttl <value>]
ARGUMENTS ENVIRONMENT Name to give the environment
FLAGS -a, --account=<value> Architect account --description=<value> Environment Description --platform=<value> Architect platform --ttl=<value> The TTL of the environment in a duration of time, ex. 30d, 12h, or 30m
DESCRIPTION Register a new environment with Architect Cloud
ALIASES $ architect environment:create $ architect envs:create $ architect env:create
EXAMPLES environment:create --account=myaccount myenvironment
environment:create --account=myaccount --ttl=5days --description="My new temporary Architect environment" myenvironment
architect env:deregister [ENVIRONMENT]
Deregister an environment
USAGE $ architect env:deregister [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
architect env:destroy [ENVIRONMENT]
Deregister an environment
USAGE $ architect env:destroy [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
architect env:search [QUERY]
Search environments you have access to
USAGE $ architect env:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
architect environment:create [ENVIRONMENT]
Register a new environment with Architect Cloud
USAGE $ architect environment:create [ENVIRONMENT] [-a <value>] [--platform <value>] [--description <value>] [--ttl <value>]
ARGUMENTS ENVIRONMENT Name to give the environment
FLAGS -a, --account=<value> Architect account --description=<value> Environment Description --platform=<value> Architect platform --ttl=<value> The TTL of the environment in a duration of time, ex. 30d, 12h, or 30m
DESCRIPTION Register a new environment with Architect Cloud
ALIASES $ architect environment:create $ architect envs:create $ architect env:create
EXAMPLES environment:create --account=myaccount myenvironment
environment:create --account=myaccount --ttl=5days --description="My new temporary Architect environment" myenvironment
architect environment:deregister [ENVIRONMENT]
Deregister an environment
USAGE $ architect environment:deregister [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
architect environment:destroy [ENVIRONMENT]
Deregister an environment
USAGE $ architect environment:destroy [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
architect environments [QUERY]
Search environments you have access to
USAGE $ architect environments [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
See code: src/commands/environments/index.ts
architect environments:create [ENVIRONMENT]
Register a new environment with Architect Cloud
USAGE $ architect environments:create [ENVIRONMENT] [-a <value>] [--platform <value>] [--description <value>] [--ttl <value>]
ARGUMENTS ENVIRONMENT Name to give the environment
FLAGS -a, --account=<value> Architect account --description=<value> Environment Description --platform=<value> Architect platform --ttl=<value> The TTL of the environment in a duration of time, ex. 30d, 12h, or 30m
DESCRIPTION Register a new environment with Architect Cloud
ALIASES $ architect environment:create $ architect envs:create $ architect env:create
EXAMPLES environment:create --account=myaccount myenvironment
environment:create --account=myaccount --ttl=5days --description="My new temporary Architect environment" myenvironment
See code: src/commands/environments/create.ts
architect environments:destroy [ENVIRONMENT]
Deregister an environment
USAGE $ architect environments:destroy [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
See code: src/commands/environments/destroy.ts
architect environments:search [QUERY]
Search environments you have access to
USAGE $ architect environments:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
architect envs [QUERY]
Search environments you have access to
USAGE $ architect envs [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
architect envs:create [ENVIRONMENT]
Register a new environment with Architect Cloud
USAGE $ architect envs:create [ENVIRONMENT] [-a <value>] [--platform <value>] [--description <value>] [--ttl <value>]
ARGUMENTS ENVIRONMENT Name to give the environment
FLAGS -a, --account=<value> Architect account --description=<value> Environment Description --platform=<value> Architect platform --ttl=<value> The TTL of the environment in a duration of time, ex. 30d, 12h, or 30m
DESCRIPTION Register a new environment with Architect Cloud
ALIASES $ architect environment:create $ architect envs:create $ architect env:create
EXAMPLES environment:create --account=myaccount myenvironment
environment:create --account=myaccount --ttl=5days --description="My new temporary Architect environment" myenvironment
architect envs:destroy [ENVIRONMENT]
Deregister an environment
USAGE $ architect envs:destroy [ENVIRONMENT] [-a <value>] [--auto-approve] [-f]
ARGUMENTS ENVIRONMENT Name of the environment to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the environment is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister an environment
ALIASES $ architect environment:destroy $ architect envs:destroy $ architect env:destroy $ architect env:deregister $ architect environment:deregister
EXAMPLES $ architect environment:destroy --account=myaccount myenvironment
$ architect environment:deregister --account=myaccount --auto-approve --force myenvironment
architect envs:search [QUERY]
Search environments you have access to
USAGE $ architect envs:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search term used to filter the results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search environments you have access to
ALIASES $ architect environments $ architect envs $ architect env $ architect environments:search $ architect envs:search $ architect env:search
EXAMPLES $ architect environments
$ architect environments --account=myaccount
$ architect environments myenvironment
architect exec [RESOURCE] [FLAGS] -- [COMMAND]
Exec into service instances
USAGE $ architect exec [RESOURCE] [FLAGS] -- [COMMAND]
ARGUMENTS RESOURCE Name of resource
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment -i, --[no-]stdin Pass stdin to the container. Only works on remote deploys. -t, --[no-]tty Stdin is a TTY. If the flag isn't supplied, tty or no-tty is automatically detected.
DESCRIPTION Exec into service instances
EXAMPLES $ architect exec -- ls
$ architect exec -- /bin/sh
$ architect exec --account myaccount --environment myenvironment mycomponent.services.app -- /bin/sh
See code: src/commands/exec.ts
architect help [COMMAND]
Display help for architect.
USAGE $ architect help [COMMAND] [-n]
ARGUMENTS COMMAND Command to show help for.
FLAGS -n, --nested-commands Include all nested commands in the output.
DESCRIPTION Display help for architect.
See code: @oclif/plugin-help
architect init
Initialize an architect component from an existing docker-compose file
USAGE $ architect init [-o <value>] [-n <value>] [--from-compose <value>]
FLAGS -n, --name=<value> -o, --component-file=<value> [default: architect.yml] Path where the component file should be written to --from-compose=<value>
DESCRIPTION Initialize an architect component from an existing docker-compose file
EXAMPLES $ architect init
$ architect init --name=mycomponent
$ architect init --from-compose=mycompose.yml --component-file=architect.yml
See code: src/commands/init.ts
architect link [COMPONENTPATH]
Link a local component to the host to be used to power local deployments.
USAGE $ architect link [COMPONENTPATH]
ARGUMENTS COMPONENTPATH [default: .] The path of the component to link
DESCRIPTION Link a local component to the host to be used to power local deployments.
EXAMPLES $ architect link
$ architect link -p ./mycomponent/architect.yml
See code: src/commands/link/index.ts
architect link:list
List all linked components.
USAGE $ architect link:list
DESCRIPTION List all linked components.
EXAMPLES $ architect link:list
See code: src/commands/link/list.ts
architect login
Login to the Architect Cloud platform
USAGE $ architect login [-e <value>] [-p <value>]
FLAGS -e, --email=<value> Email -p, --password=<value> Password
DESCRIPTION Login to the Architect Cloud platform
EXAMPLES $ architect login
$ architect login -e my-email-address@my-email-domain.com
See code: src/commands/login.ts
architect logout
Logout from the Architect registry
USAGE $ architect logout
DESCRIPTION Logout from the Architect registry
EXAMPLES $ architect logout
See code: src/commands/logout.ts
architect logs [RESOURCE]
Get logs from services both locally and remote
USAGE $ architect logs [RESOURCE] [-a <value>] [-e <value>] [-f] [--since <value>] [--raw] [--tail <value>] [--timestamps]
ARGUMENTS RESOURCE Name of resource
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment -f, --follow Specify if the logs should be streamed. --raw Show the raw output of the logs. --since=<value> Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. --tail=<value> [default: -1] Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. --timestamps Include timestamps on each line in the log output.
DESCRIPTION Get logs from services both locally and remote
EXAMPLES $ architect logs
$ architect logs --follow --raw --timestamps
See code: src/commands/logs.ts
architect platform [QUERY]
Search for platforms on Architect Cloud
USAGE $ architect platform [QUERY] [-a <value>]
ARGUMENTS QUERY Search query used to filter results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search for platforms on Architect Cloud
ALIASES $ architect platform $ architect platform:search $ architect platforms $ architect platforms:search
EXAMPLES $ architect platforms
$ architect platforms --account=myaccount myplatform
architect platform:create [PLATFORM]
Register a new platform with Architect Cloud
USAGE $ architect platform:create [PLATFORM] [-a <value>] [--auto-approve] [-t KUBERNETES|kubernetes] [-k <value> | -h <value>] [--flag <value>]
ARGUMENTS PLATFORM Name to give the platform
FLAGS -a, --account=<value> Architect account -h, --host=<value> -k, --kubeconfig=<value> [default: ~/.kube/config] -t, --type=<option> <options: KUBERNETES|kubernetes> --auto-approve --flag=<value>... [default: ]
DESCRIPTION Register a new platform with Architect Cloud
ALIASES $ architect platforms:register $ architect platform:create $ architect platforms:create
EXAMPLES $ architect platforms:create --account=myaccount
$ architect platforms:register --account=myaccount --type=kubernetes --kubeconfig=~/.kube/config --auto-approve
architect platform:destroy [PLATFORM]
Deregister a platform from Architect
USAGE $ architect platform:destroy [PLATFORM] [-a <value>] [--auto-approve] [-f]
ARGUMENTS PLATFORM Name of the platform to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the platform is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister a platform from Architect
ALIASES $ architect platforms:deregister $ architect platform:destroy $ architect platforms:destroy
EXAMPLES $ architect platform:destroy --account=myaccount architect
$ architect platforms:deregister --account=myaccount --auto-approve --force architect
architect platform:search [QUERY]
Search for platforms on Architect Cloud
USAGE $ architect platform:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search query used to filter results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search for platforms on Architect Cloud
ALIASES $ architect platform $ architect platform:search $ architect platforms $ architect platforms:search
EXAMPLES $ architect platforms
$ architect platforms --account=myaccount myplatform
architect platforms [QUERY]
Search for platforms on Architect Cloud
USAGE $ architect platforms [QUERY] [-a <value>]
ARGUMENTS QUERY Search query used to filter results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search for platforms on Architect Cloud
ALIASES $ architect platform $ architect platform:search $ architect platforms $ architect platforms:search
EXAMPLES $ architect platforms
$ architect platforms --account=myaccount myplatform
See code: src/commands/platforms/index.ts
architect platforms:create [PLATFORM]
Register a new platform with Architect Cloud
USAGE $ architect platforms:create [PLATFORM] [-a <value>] [--auto-approve] [-t KUBERNETES|kubernetes] [-k <value> | -h <value>] [--flag <value>]
ARGUMENTS PLATFORM Name to give the platform
FLAGS -a, --account=<value> Architect account -h, --host=<value> -k, --kubeconfig=<value> [default: ~/.kube/config] -t, --type=<option> <options: KUBERNETES|kubernetes> --auto-approve --flag=<value>... [default: ]
DESCRIPTION Register a new platform with Architect Cloud
ALIASES $ architect platforms:register $ architect platform:create $ architect platforms:create
EXAMPLES $ architect platforms:create --account=myaccount
$ architect platforms:register --account=myaccount --type=kubernetes --kubeconfig=~/.kube/config --auto-approve
See code: src/commands/platforms/create.ts
architect platforms:deregister [PLATFORM]
Deregister a platform from Architect
USAGE $ architect platforms:deregister [PLATFORM] [-a <value>] [--auto-approve] [-f]
ARGUMENTS PLATFORM Name of the platform to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the platform is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister a platform from Architect
ALIASES $ architect platforms:deregister $ architect platform:destroy $ architect platforms:destroy
EXAMPLES $ architect platform:destroy --account=myaccount architect
$ architect platforms:deregister --account=myaccount --auto-approve --force architect
architect platforms:destroy [PLATFORM]
Deregister a platform from Architect
USAGE $ architect platforms:destroy [PLATFORM] [-a <value>] [--auto-approve] [-f]
ARGUMENTS PLATFORM Name of the platform to deregister
FLAGS -a, --account=<value> Architect account -f, --force Force the deletion even if the platform is not empty --auto-approve Automatically apply the changes
DESCRIPTION Deregister a platform from Architect
ALIASES $ architect platforms:deregister $ architect platform:destroy $ architect platforms:destroy
EXAMPLES $ architect platform:destroy --account=myaccount architect
$ architect platforms:deregister --account=myaccount --auto-approve --force architect
See code: src/commands/platforms/destroy.ts
architect platforms:register [PLATFORM]
Register a new platform with Architect Cloud
USAGE $ architect platforms:register [PLATFORM] [-a <value>] [--auto-approve] [-t KUBERNETES|kubernetes] [-k <value> | -h <value>] [--flag <value>]
ARGUMENTS PLATFORM Name to give the platform
FLAGS -a, --account=<value> Architect account -h, --host=<value> -k, --kubeconfig=<value> [default: ~/.kube/config] -t, --type=<option> <options: KUBERNETES|kubernetes> --auto-approve --flag=<value>... [default: ]
DESCRIPTION Register a new platform with Architect Cloud
ALIASES $ architect platforms:register $ architect platform:create $ architect platforms:create
EXAMPLES $ architect platforms:create --account=myaccount
$ architect platforms:register --account=myaccount --type=kubernetes --kubeconfig=~/.kube/config --auto-approve
architect platforms:search [QUERY]
Search for platforms on Architect Cloud
USAGE $ architect platforms:search [QUERY] [-a <value>]
ARGUMENTS QUERY Search query used to filter results
FLAGS -a, --account=<value> Architect account
DESCRIPTION Search for platforms on Architect Cloud
ALIASES $ architect platform $ architect platform:search $ architect platforms $ architect platforms:search
EXAMPLES $ architect platforms
$ architect platforms --account=myaccount myplatform
architect register [COMPONENT]
Register a new Component with Architect Cloud
USAGE $ architect register [COMPONENT] [-a <value>] [--arg <value>] [-t <value> | ] [--architecture <value>] [--cache-directory <value>]
ARGUMENTS COMPONENT [default: ./] Path to a component to register
FLAGS -a, --account=<value> Architect account -t, --tag=<value> [default: latest] Tag to give to the new component --architecture=<value>... [default: amd64] Architecture(s) to target for Docker image builds --arg=<value>... Build arg(s) to pass to docker build --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
DESCRIPTION Register a new Component with Architect Cloud
ALIASES $ architect component:register $ architect components:register $ architect c:register $ architect comp:register
EXAMPLES $ architect register
$ architect register -t latest
$ architect register -a myaccount -t latest ./architect.yml ../myothercomponent/architect.yml
$ architect register -a myaccount -t latest --arg NODE_ENV=dev ./architect.yml
See code: src/commands/register.ts
architect secrets SECRETS_FILE
Download secrets from an account or an environment
USAGE $ architect secrets [SECRETS_FILE] [-a <value>] [-e <value>]
ARGUMENTS SECRETS_FILE Secrets filename to download secrets
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment
DESCRIPTION Download secrets from an account or an environment
ALIASES $ architect secrets $ architect secrets/get
EXAMPLES $ architect secrets ./mysecrets.yml
$ architect secrets --account=myaccount --environment=myenvironment ../mysecrets.yml
architect secrets/get SECRETS_FILE
Download secrets from an account or an environment
USAGE $ architect secrets/get [SECRETS_FILE] [-a <value>] [-e <value>]
ARGUMENTS SECRETS_FILE Secrets filename to download secrets
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment
DESCRIPTION Download secrets from an account or an environment
ALIASES $ architect secrets $ architect secrets/get
EXAMPLES $ architect secrets ./mysecrets.yml
$ architect secrets --account=myaccount --environment=myenvironment ../mysecrets.yml
architect secrets:download SECRETS_FILE
Download secrets from an account or an environment
USAGE $ architect secrets:download [SECRETS_FILE] [-a <value>] [-e <value>]
ARGUMENTS SECRETS_FILE Secrets filename to download secrets
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment
DESCRIPTION Download secrets from an account or an environment
ALIASES $ architect secrets $ architect secrets/get
EXAMPLES $ architect secrets ./mysecrets.yml
$ architect secrets --account=myaccount --environment=myenvironment ../mysecrets.yml
See code: src/commands/secrets/download.ts
architect secrets:set SECRETS_FILE
Upload secrets from a file to an account or an environment
USAGE $ architect secrets:set [SECRETS_FILE] [-a <value>] [-e <value>] [--override]
ARGUMENTS SECRETS_FILE Secrets file to be uploaded
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment --override Allow override of existing secrets
DESCRIPTION Upload secrets from a file to an account or an environment
ALIASES $ architect secrets:set
EXAMPLES $ architect secrets:set --account=myaccount --environment=myenvironment ./mysecrets.yml
$ architect secrets:set --account=myaccount --override ./mysecrets.yml
architect secrets:upload SECRETS_FILE
Upload secrets from a file to an account or an environment
USAGE $ architect secrets:upload [SECRETS_FILE] [-a <value>] [-e <value>] [--override]
ARGUMENTS SECRETS_FILE Secrets file to be uploaded
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment --override Allow override of existing secrets
DESCRIPTION Upload secrets from a file to an account or an environment
ALIASES $ architect secrets:set
EXAMPLES $ architect secrets:set --account=myaccount --environment=myenvironment ./mysecrets.yml
$ architect secrets:set --account=myaccount --override ./mysecrets.yml
See code: src/commands/secrets/upload.ts
architect task COMPONENT TASK
Execute a task in the given environment
USAGE $ architect task [COMPONENT] [TASK] [-l | -a <value> | | | ] [-o <value> | | -e <value> | | | ]
ARGUMENTS COMPONENT The name of the component that contains the task to execute TASK The name of the task to execute
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment -l, --local Deploy the stack locally instead of via Architect Cloud -o, --compose-file=<value> Path where the compose file should be written to
DESCRIPTION Execute a task in the given environment
ALIASES $ architect task:exec
EXAMPLES $ architect task --account=myaccount --environment=myenvironment mycomponent:latest mytask
See code: src/commands/task.ts
architect task:exec COMPONENT TASK
Execute a task in the given environment
USAGE $ architect task:exec [COMPONENT] [TASK] [-l | -a <value> | | | ] [-o <value> | | -e <value> | | | ]
ARGUMENTS COMPONENT The name of the component that contains the task to execute TASK The name of the task to execute
FLAGS -a, --account=<value> Architect account -e, --environment=<value> Architect environment -l, --local Deploy the stack locally instead of via Architect Cloud -o, --compose-file=<value> Path where the compose file should be written to
DESCRIPTION Execute a task in the given environment
ALIASES $ architect task:exec
EXAMPLES $ architect task --account=myaccount --environment=myenvironment mycomponent:latest mytask
architect unlink [COMPONENTPATHORNAME]
Unlink a component from the host by path or name
USAGE $ architect unlink [COMPONENTPATHORNAME] [--all]
FLAGS --all Unlink all components registered locally
DESCRIPTION Unlink a component from the host by path or name
EXAMPLES $ architect unlink
$ architect unlink -p ../architect.yml
$ architect unlink -p mycomponent
See code: src/commands/unlink.ts
architect validate [CONFIGS_OR_COMPONENTS]
Validate that an architect.yml is syntactically correct.
USAGE $ architect validate [CONFIGS_OR_COMPONENTS]
ARGUMENTS CONFIGS_OR_COMPONENTS Path to an architect.yml file or component `account/component:latest`. Multiple components are accepted.
DESCRIPTION Validate that an architect.yml is syntactically correct.
ALIASES $ architect component:validate $ architect components:validate $ architect c:validate $ architect comp:validate $ architect validate
EXAMPLES $ architect validate .
$ architect validate ../mycomponent/architect.yml ../myothercomponent/architect.yml
See code: src/commands/validate.ts
architect whoami
Get the logged in user
USAGE $ architect whoami
DESCRIPTION Get the logged in user
ALIASES $ architect whoami
EXAMPLES $ architect whoami
See code: src/commands/whoami.ts