@architect-io/cli
Command-line interface for Architect.io
Last updated 17 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-cli

Command-line interface for Architect.io

oclif Version CircleCI Downloads/week License

Usage

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

Commands

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-1588860240993.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
  -p, --platform=platform
  -t, --type=KUBERNETES|kubernetes|ARCHITECT_PUBLIC|architect_public|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 environment:create
  $ architect environments: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
  -d, --description=description
  -h, --help                     show CLI help

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 init
       ? Name of service (account/name) account-name/service-name
       ? Does your service connect to any dependencies? Yes
       ? Please provide the name of or file path to a dependent service account-name/dependency:latest
       ? What environment parameter should be enriched with the location of this dependency? DEPENDENCY_ADDR
       ? Any more dependencies? No
       ? Does your service expose any configurable parameters? Yes
       ? What is the name of this parameter? ENV_PARAM
       ? Is this parameter required? Yes
       ? What is the default value of this parameter (if any)? param_value
       ? Any more parameters? No
       ? When running locally, what command should be used to start the service (leave blank to use default docker CMD)?
       npm run start:dev
       Success! A manifest for this service has been added at `architect.json`.

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 link [SERVICEPATH]

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

USAGE
  $ architect link [SERVICEPATH]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/link.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 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 platforms
  $ architect platforms:search

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

architect platforms:destroy NAMESPACED_PLATFORM

Destroy a platform

USAGE
  $ architect platforms:destroy NAMESPACED_PLATFORM

ARGUMENTS
  NAMESPACED_PLATFORM  Name of the platform to destroy

OPTIONS
  -a, --auto_approve  Automatically apply the changes without reviewing the diff
  -h, --help          show CLI help

ALIASES
  $ architect platform:destroy

See code: src/commands/platforms/destroy.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 register

Register a new Service with Architect Cloud

USAGE
  $ architect register

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

ALIASES
  $ architect service:register
  $ architect services:register
  $ architect svcs:register
  $ architect svc:register

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

architect unlink [SERVICEPATHORNAME]

Unlink a service from the host by path or name

USAGE
  $ architect unlink [SERVICEPATHORNAME]

OPTIONS
  -a, --all   Unlink all services registered locally
  -h, --help  show CLI help

See code: src/commands/unlink.ts

Current Tags

  • 0.4.7                                ...           latest (17 days ago)

65 Versions

  • 0.4.7                                ...           17 days ago
  • 0.4.6                                ...           a month ago
  • 0.4.6-rc.6                                ...           a month ago
  • 0.4.6-rc.5                                ...           a month ago
  • 0.4.6-rc.4                                ...           a month ago
  • 0.4.6-rc.3                                ...           a month ago
  • 0.4.6-rc.2                                ...           a month ago
  • 0.4.6-rc.1                                ...           a month ago
  • 0.4.6-rc.0                                ...           a month ago
  • 0.4.5                                ...           a month ago
  • 0.4.4                                ...           a month ago
  • 0.4.4-rc.7                                ...           a month ago
  • 0.4.4-rc.6                                ...           a month ago
  • 0.4.4-rc.5                                ...           a month ago
  • 0.4.4-rc.4                                ...           a month ago
  • 0.4.4-rc.3                                ...           a month ago
  • 0.4.4-rc.2                                ...           a month ago
  • 0.4.4-rc.1                                ...           a month ago
  • 0.4.4-rc.0                                ...           a month ago
  • 0.4.3                                ...           a month ago
  • 0.4.3-rc.4                                ...           a month ago
  • 0.4.3-rc.3                                ...           a month ago
  • 0.4.3-rc.2                                ...           a month ago
  • 0.4.3-rc.1                                ...           2 months ago
  • 0.4.3-rc.0                                ...           2 months ago
  • 0.4.2                                ...           2 months ago
  • 0.4.2-rc.3                                ...           2 months ago
  • 0.4.2-rc.2                                ...           2 months ago
  • 0.4.2-rc.1                                ...           2 months ago
  • 0.4.2-rc.0                                ...           2 months ago
  • 0.4.1                                ...           2 months ago
  • 0.4.1-rc.1                                ...           2 months ago
  • 0.4.0                                ...           2 months ago
  • 0.3.20-rc.0                                ...           2 months ago
  • 0.3.19                                ...           2 months ago
  • 0.3.18                                ...           2 months ago
  • 0.3.17                                ...           2 months ago
  • 0.3.16                                ...           2 months ago
  • 0.3.15                                ...           2 months ago
  • 0.3.14                                ...           2 months ago
  • 0.3.13                                ...           3 months ago
  • 0.3.12                                ...           3 months ago
  • 0.3.11                                ...           3 months ago
  • 0.3.10                                ...           4 months ago
  • 0.3.9                                ...           4 months ago
  • 0.3.8                                ...           5 months ago
  • 0.3.4                                ...           5 months ago
  • 0.3.3                                ...           7 months ago
  • 0.3.2                                ...           8 months ago
  • 0.3.1                                ...           8 months ago
  • 0.3.0                                ...           8 months ago
  • 0.2.4                                ...           9 months ago
  • 0.2.3                                ...           9 months ago
  • 0.2.2 [deprecated]           ...           9 months ago
  • 0.2.1 [deprecated]           ...           10 months ago
  • 0.2.0 [deprecated]           ...           10 months ago
  • 0.1.9 [deprecated]           ...           a year ago
  • 0.1.8 [deprecated]           ...           a year ago
  • 0.1.7 [deprecated]           ...           a year ago
  • 0.1.6 [deprecated]           ...           a year ago
  • 0.1.5 [deprecated]           ...           a year ago
  • 0.1.3 [deprecated]           ...           a year ago
  • 0.1.2 [deprecated]           ...           a year ago
  • 0.1.1 [deprecated]           ...           a year ago
  • 0.1.0 [deprecated]           ...           a year ago
Downloads
Today 0
This Week 0
This Month 122
Last Day 0
Last Week 65
Last Month 475
Dependencies (30)
Dev Dependencies (30)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |