Skip to content
Command line interface for running Architect services locally
Branch: master
Clone or download
Latest commit 49b1fa1 May 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Added remote docker setup to CI pipeline Mar 7, 2019
bin
src
test
.editorconfig
.gitignore Switched to NPM instead of yarn Nov 4, 2018
.gitmodules
Dockerfile Updated build command to recurse and generate client stubs Mar 31, 2019
Dockerfile-Base
README.md
package-lock.json Added `architect login` cmd May 17, 2019
package.json
tsconfig.json
tslint.json

README.md

Architect CLI

View Documentation

License Version License

Command line interface for creating and deploying architect services.

Requirements

  • Node >= v8.x

Usage

$ npm install -g @architect-io/cli
$ architect COMMAND
running command...
$ architect (-v|--version|version)
@architect-io/cli/0.1.9 darwin-x64 node-v10.15.0
$ architect --help [COMMAND]
USAGE
  $ architect COMMAND
...

Commands

architect build [CONTEXT]

Create an architect.json file for a service

USAGE
  $ architect build [CONTEXT]

ARGUMENTS
  CONTEXT  Path to the service to build

OPTIONS
  -h, --help       show CLI help
  -r, --recursive  Whether or not to build images for the cited dependencies
  -t, --tag=tag    Name and optionally a tag in the ‘name:tag’ format

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

Create an architect.json file for a service

USAGE
  $ architect init

OPTIONS
  -a, --author=author
  -d, --description=description
  -h, --help                     show CLI help
  -k, --keywords=keywords
  -l, --license=license          [default: MIT]
  -n, --name=name                [default: architect-cli]
  -v, --version=version          [default: 0.1.0]

See code: src/commands/init.ts

architect install

Install dependencies of the current service

USAGE
  $ architect install

OPTIONS
  -h, --help           show CLI help
  -p, --prefix=prefix  Path prefix indicating where the install command should execute from.
  -r, --recursive      Generate architect dependency files for all services in the dependency tree.

See code: src/commands/install.ts

architect start

Start the service locally

USAGE
  $ architect start

OPTIONS
  -c, --config_path=config_path  Path to a config file containing locations of each service in the application
  -h, --help                     show CLI help

See code: src/commands/start.ts

Special Thanks

You can’t perform that action at this time.