conduit-cli

The CLI to help you when developing conduit.

• Limitations
• Usage
• Commands
• Roadmap

Limitations

While the CLI is capable of bootstrapping any Conduit release, including legacy ones, generateSchema and generateClient commands currently require that you target >= v0.14.5.

Usage

$ npm install -g @conduitplatform/cli
$ conduit COMMAND
running command...
$ conduit (--version|-v)
@conduitplatform/cli/0.0.7 linux-x64 node-v16.15.0
$ conduit --help [COMMAND]
USAGE
  $ conduit COMMAND
...

Commands

• conduit deploy rm
• conduit deploy setup
• conduit deploy start
• conduit deploy stop
• conduit deploy update
• conduit generateClient graphql
• conduit generateClient rest
• conduit generateSchema [PATH]
• conduit help [COMMAND]
• conduit init

conduit deploy rm

Remove your local Conduit deployment

USAGE
  $ conduit deploy rm [--wipe-data] [--defaults]

FLAGS
  --defaults   Select default values
  --wipe-data  Wipe data volumes

DESCRIPTION
  Remove your local Conduit deployment

conduit deploy setup

Bootstrap a local Conduit deployment

USAGE
  $ conduit deploy setup [--config] [--target <value>]

FLAGS
  --config          Enable manual deployment configuration
  --target=<value>  Specify target tag

DESCRIPTION
  Bootstrap a local Conduit deployment

conduit deploy start

Bring up your local Conduit deployment

USAGE
  $ conduit deploy start

DESCRIPTION
  Bring up your local Conduit deployment

conduit deploy stop

Bring down your local Conduit deployment

USAGE
  $ conduit deploy stop

DESCRIPTION
  Bring down your local Conduit deployment

conduit deploy update

Update your local Conduit deployment

USAGE
  $ conduit deploy update [--config] [--target <value>]

FLAGS
  --config          Enable manual deployment configuration
  --target=<value>  Specify target tag

DESCRIPTION
  Update your local Conduit deployment

conduit generateClient graphql

Generate client libraries for your Conduit GraphQL APIs

USAGE
  $ conduit generateClient graphql [-t <value>] [-p <value>]

FLAGS
  -p, --output-path=<value>  Path to store archived library in
  -t, --client-type=<value>  The client type to generate a library for

DESCRIPTION
  Generate client libraries for your Conduit GraphQL APIs

conduit generateClient rest

Generate client libraries for your Conduit REST APIs

USAGE
  $ conduit generateClient rest [-t <value>] [-p <value>]

FLAGS
  -p, --output-path=<value>  Path to store archived library in
  -t, --client-type=<value>  The client type to generate a library for

DESCRIPTION
  Generate client libraries for your Conduit REST APIs

conduit generateSchema [PATH]

Generate Schema TS files for registered Conduit schemas

USAGE
  $ conduit generateSchema [PATH]

DESCRIPTION
  Generate Schema TS files for registered Conduit schemas

EXAMPLES
  $ conduit generate-schema
  ...
  Generating schemas

See code: src/commands/generateSchema.ts

conduit help [COMMAND]

Display help for conduit.

USAGE
  $ conduit 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 conduit.

See code: @oclif/plugin-help

conduit init

Initialize the CLI to communicate with Conduit

USAGE
  $ conduit init [-r]

FLAGS
  -r, --relogin  Reuses API urls and master key from existing configuration

DESCRIPTION
  Initialize the CLI to communicate with Conduit

EXAMPLES
  $ conduit init
  ...
  Attempting login
  Login Successful!

See code: src/commands/init.ts

Roadmap

• Support more operations (ex. boilerplate code generation)
• Change generator functions to use a proper engine
• Support more languages for code generation