@architect-io/cli
Command-line interface for Architect.io
Last updated 13 days ago by david.thor .
GPL-3.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @architect-io/cli 
SYNC missed versions from official npm registry.

Architect Logo

oclif Build Version License

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.

Usage

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

Note: the CLI uses the keytar library to store your Architect Cloud credentials securely on your machine. If your OS doesn't support keytar (like many linux systems) you will see an install error in the logs during NPM install. Keytar is an optional dependency and the install will complete successfully despite this error, but you may hide it by running npm install with the --unsafe flag.

Commands

architect autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ architect autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ architect autocomplete
  $ architect autocomplete bash
  $ architect autocomplete zsh
  $ architect autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

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_OR_COMPONENT

Create a deploy job on Architect Cloud or run stacks locally

USAGE
  $ architect deploy ENVIRONMENT_CONFIG_OR_COMPONENT

ARGUMENTS
  ENVIRONMENT_CONFIG_OR_COMPONENT  Path to an environment config file or component `account/component:latest`

OPTIONS
  -a, --account=account            Architect Account
  -d, --detached                   Run in detached mode
  -e, --environment=environment    Architect Environment
  -h, --help                       show CLI help
  -i, --interface=interface        [default: ] Component interfaces
  -l, --local                      Deploy the stack locally instead of via Architect Cloud

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

  -p, --parameter=parameter        [default: ] Component parameters

  --auto_approve

  --[no-]browser

See code: src/commands/deploy.ts

architect destroy

Destroy components from an environment

USAGE
  $ architect destroy

OPTIONS
  -a, --account=account          Architect Account
  -c, --components=components    Component(s) to destroy
  -e, --environment=environment  Architect Environment
  -h, --help                     show CLI help
  --auto_approve
  --[no-]browser

See code: src/commands/destroy.ts

architect environments [QUERY]

Search 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:search
  $ architect envs:search
  $ architect env:search

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

architect environments:create [ENVIRONMENT]

Register a new environment with Architect Cloud

USAGE
  $ architect environments:create [ENVIRONMENT]

ARGUMENTS
  ENVIRONMENT  Name to give the environment

OPTIONS
  -a, --account=account      Architect Account
  -h, --help                 show CLI help
  --description=description  Environment Description
  --platform=platform        Architect Platform

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

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

architect environments:destroy [ENVIRONMENT]

Destroy an environment

USAGE
  $ architect environments:destroy [ENVIRONMENT]

ARGUMENTS
  ENVIRONMENT  Name of the environment to destroy

OPTIONS
  -a, --account=account  Architect Account
  -f, --force            Force the deletion even if the environment is not empty
  -h, --help             show CLI help
  --auto_approve         Automatically apply the changes

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

See code: src/commands/environments/destroy.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 link [COMPONENTPATH]

Link a local component to the host to be used to power local deployments.

USAGE
  $ architect link [COMPONENTPATH]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/link.ts

architect login

Login to the Architect Cloud platform

USAGE
  $ architect login

OPTIONS
  -e, --email=email        Email
  -h, --help               show CLI help
  -p, --password=password  Password

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 platforms [QUERY]

Search for platforms on Architect Cloud

USAGE
  $ architect platforms [QUERY]

ARGUMENTS
  QUERY  Search query used to filter results

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ architect platform
  $ architect platform:search
  $ architect platforms
  $ architect platforms:search

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

architect platforms:create [PLATFORM]

Register a new platform with Architect Cloud

USAGE
  $ architect platforms:create [PLATFORM]

ARGUMENTS
  PLATFORM  Name to give the platform

OPTIONS
  -a, --account=account                                         Architect Account
  -h, --help                                                    show CLI help
  -h, --host=host
  -k, --kubeconfig=kubeconfig                                   [default: ~/.kube/config]
  -t, --type=KUBERNETES|kubernetes|ARCHITECT|architect|ECS|ecs
  --aws_key=aws_key
  --aws_region=aws_region
  --aws_secret=aws_secret
  --cluster_ca_cert=cluster_ca_cert                             File path of cluster_ca_cert
  --service_token=service_token                                 Service token

ALIASES
  $ architect platform:create
  $ architect platforms:create

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

architect platforms:destroy [PLATFORM]

Destroy a platform

USAGE
  $ architect platforms:destroy [PLATFORM]

ARGUMENTS
  PLATFORM  Name of the platform to destroy

OPTIONS
  -a, --account=account  Architect Account
  -h, --help             show CLI help
  --auto_approve         Automatically apply the changes

ALIASES
  $ architect platform:destroy
  $ architect platforms:destroy

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

architect register [COMPONENT]

Register a new Component with Architect Cloud

USAGE
  $ architect register [COMPONENT]

ARGUMENTS
  COMPONENT  Path to a component to register

OPTIONS
  -h, --help     show CLI help
  -t, --tag=tag  [default: latest] Tag to give to the new component

ALIASES
  $ architect component:register
  $ architect components:register
  $ architect c:register
  $ architect comp:register

See code: src/commands/register.ts

architect unlink [COMPONENTPATHORNAME]

Unlink a component from the host by path or name

USAGE
  $ architect unlink [COMPONENTPATHORNAME]

OPTIONS
  -h, --help  show CLI help
  --all       Unlink all components registered locally

See code: src/commands/unlink.ts

architect whoami

Get the logged in user

USAGE
  $ architect whoami

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ architect whoami

See code: src/commands/whoami.ts

Current Tags

  • 0.7.4                                ...           latest (13 days ago)
  • 0.7.5-rc.0                                ...           rc (7 days ago)

131 Versions

  • 0.7.5-rc.0                                ...           7 days ago
  • 0.7.4                                ...           13 days ago
  • 0.7.4-rc.4                                ...           13 days ago
  • 0.7.4-rc.3                                ...           13 days ago
  • 0.7.4-rc.2                                ...           14 days ago
  • 0.7.4-rc.1                                ...           15 days ago
  • 0.7.4-rc.0                                ...           19 days ago
  • 0.7.3                                ...           20 days ago
  • 0.7.3-rc.1                                ...           20 days ago
  • 0.7.3-rc.0                                ...           21 days ago
  • 0.7.2                                ...           22 days ago
  • 0.7.2-rc.0                                ...           22 days ago
  • 0.7.1                                ...           25 days ago
  • 0.7.1-rc.2                                ...           25 days ago
  • 0.7.1-rc.1                                ...           a month ago
  • 0.7.1-rc.0                                ...           a month ago
  • 0.7.0                                ...           a month ago
  • 0.6.5-rc.3                                ...           a month ago
  • 0.6.5-rc.2                                ...           a month ago
  • 0.6.5-rc.1                                ...           a month ago
  • 0.6.5-rc.0                                ...           a month ago
  • 0.6.4                                ...           a month ago
  • 0.6.4-rc.1                                ...           a month ago
  • 0.6.4-rc.0                                ...           a month ago
  • 0.6.3                                ...           a month ago
  • 0.6.3-rc.0                                ...           a month ago
  • 0.6.2                                ...           a month ago
  • 0.6.2-rc.3                                ...           a month ago
  • 0.6.2-rc.2                                ...           a month ago
  • 0.6.2-rc.1                                ...           a month ago
  • 0.6.2-rc.0                                ...           a month ago
  • 0.6.1                                ...           a month ago
  • 0.6.1-rc.4                                ...           a month ago
  • 0.6.1-rc.3                                ...           a month ago
  • 0.6.1-rc.2                                ...           a month ago
  • 0.6.1-rc.1                                ...           2 months ago
  • 0.6.1-rc.0                                ...           2 months ago
  • 0.6.0                                ...           2 months ago
  • 0.5.3-rc.1                                ...           2 months ago
  • 0.5.3-rc.0                                ...           2 months ago
  • 0.5.2                                ...           2 months ago
  • 0.5.2-rc.14                                ...           2 months ago
  • 0.5.2-rc.13                                ...           2 months ago
  • 0.5.2-rc.12                                ...           2 months ago
  • 0.5.2-rc.11                                ...           2 months ago
  • 0.5.2-rc.10                                ...           2 months ago
  • 0.5.2-rc.9                                ...           2 months ago
  • 0.5.2-rc.8                                ...           2 months ago
  • 0.5.2-rc.7                                ...           2 months ago
  • 0.5.2-rc.6                                ...           2 months ago
  • 0.5.2-rc.5                                ...           2 months ago
  • 0.5.2-rc.4                                ...           2 months ago
  • 0.5.2-rc.3                                ...           2 months ago
  • 0.5.2-rc.2                                ...           2 months ago
  • 0.5.2-rc.1                                ...           2 months ago
  • 0.5.2-rc.0                                ...           2 months ago
  • 0.5.1                                ...           2 months ago
  • 0.5.1-rc.0                                ...           2 months ago
  • 0.5.0                                ...           2 months ago
  • 0.4.10-rc.18                                ...           2 months ago
  • 0.4.10-rc.17                                ...           2 months ago
  • 0.4.10-rc.16                                ...           2 months ago
  • 0.4.10-rc.15                                ...           2 months ago
  • 0.4.10-rc.14                                ...           2 months ago
  • 0.4.9                                ...           3 months ago
  • 0.4.8                                ...           4 months ago
  • 0.4.7                                ...           5 months ago
  • 0.4.6                                ...           5 months ago
  • 0.4.6-rc.6                                ...           5 months ago
  • 0.4.6-rc.5                                ...           5 months ago
  • 0.4.6-rc.4                                ...           5 months ago
  • 0.4.6-rc.3                                ...           5 months ago
  • 0.4.6-rc.2                                ...           5 months ago
  • 0.4.6-rc.1                                ...           5 months ago
  • 0.4.6-rc.0                                ...           5 months ago
  • 0.4.5                                ...           5 months ago
  • 0.4.4                                ...           5 months ago
  • 0.4.4-rc.7                                ...           5 months ago
  • 0.4.4-rc.6                                ...           5 months ago
  • 0.4.4-rc.5                                ...           5 months ago
  • 0.4.4-rc.4                                ...           5 months ago
  • 0.4.4-rc.3                                ...           5 months ago
  • 0.4.4-rc.2                                ...           5 months ago
  • 0.4.4-rc.1                                ...           5 months ago
  • 0.4.4-rc.0                                ...           5 months ago
  • 0.4.3                                ...           5 months ago
  • 0.4.3-rc.4                                ...           5 months ago
  • 0.4.3-rc.3                                ...           5 months ago
  • 0.4.3-rc.2                                ...           5 months ago
  • 0.4.3-rc.1                                ...           5 months ago
  • 0.4.3-rc.0                                ...           5 months ago
  • 0.4.2                                ...           5 months ago
  • 0.4.2-rc.3                                ...           5 months ago
  • 0.4.2-rc.2                                ...           5 months ago
  • 0.4.2-rc.1                                ...           5 months ago
  • 0.4.2-rc.0                                ...           5 months ago
  • 0.4.1                                ...           6 months ago
  • 0.4.1-rc.1                                ...           6 months ago
  • 0.4.0                                ...           6 months ago
  • 0.3.20-rc.0                                ...           6 months ago
  • 0.3.19                                ...           6 months ago
  • 0.3.18                                ...           6 months ago
  • 0.3.17                                ...           6 months ago
  • 0.3.16                                ...           6 months ago
  • 0.3.15                                ...           6 months ago
  • 0.3.14                                ...           6 months ago
  • 0.3.13                                ...           7 months ago
  • 0.3.12                                ...           7 months ago
  • 0.3.11                                ...           7 months ago
  • 0.3.10                                ...           8 months ago
  • 0.3.9                                ...           8 months ago
  • 0.3.8                                ...           9 months ago
  • 0.3.4                                ...           9 months ago
  • 0.3.3                                ...           a year ago
  • 0.3.2                                ...           a year ago
  • 0.3.1                                ...           a year ago
  • 0.3.0                                ...           a year ago
  • 0.2.4                                ...           a year ago
  • 0.2.3                                ...           a year ago
  • 0.2.2 [deprecated]           ...           a year ago
  • 0.2.1 [deprecated]           ...           a year ago
  • 0.2.0 [deprecated]           ...           a year ago
  • 0.1.9 [deprecated]           ...           a year ago
  • 0.1.8 [deprecated]           ...           2 years ago
  • 0.1.7 [deprecated]           ...           2 years ago
  • 0.1.6 [deprecated]           ...           2 years ago
  • 0.1.5 [deprecated]           ...           2 years ago
  • 0.1.3 [deprecated]           ...           2 years ago
  • 0.1.2 [deprecated]           ...           2 years ago
  • 0.1.1 [deprecated]           ...           2 years ago
  • 0.1.0 [deprecated]           ...           2 years ago
Downloads
Today 0
This Week 1
This Month 152
Last Day 0
Last Week 18
Last Month 518
Dependencies (38)
Dev Dependencies (29)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |