https://github.com/conduitplatform/cli
https://github.com/conduitplatform/cli
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/conduitplatform/cli
- Owner: ConduitPlatform
- License: mit
- Created: 2022-01-30T17:00:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T09:34:55.000Z (about 1 year ago)
- Last Synced: 2025-04-14T10:37:03.875Z (about 1 year ago)
- Language: TypeScript
- Size: 362 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
The only Backend you'll ever need.
# Conduit CLI
Conduit's CLI is a multipurpose tool that's meant to facilitate your development experience and speed up your work
regardless of whether you're deploying a Conduit instance for your project, developing custom modules or even
contributing to the upstream project in your spare time.
If you treat it right, it's gonna deploy local instances of Conduit for you, provide API client library generation for
your frontend team, generate some TypeScript code for your custom modules and even handle your laundry... nah, wait I
thought we were not actually releasing this one until the next release, right?
Anyway, point is, if you're already using Conduit for your projects or
simply intend to give it a ride for the first time, you're most likely going to want to use this.
## Requirements
While the use of Docker is not required for every single piece of functionality provided, for most typical use cases
you're going to [need Docker installed](https://docs.docker.com/get-docker) and configured so that your user is capable
of utilizing it without superuser privileges.
For Linux users, this usually means adding your user to the `docker` group.
You're also going to need some form of support for [docker compose](https://docs.docker.com/compose/install/).
Conduit's CLI supports both v2 and v1. The former comes pre-installed with the latest versions of Docker Desktop.
[](https://oclif.io)
[//]: # ([](https://npmjs.org/package/conduit-cli))
[//]: # ([](https://npmjs.org/package/@conduitplatform/cli))
[//]: # ([](https://github.com/ConduitPlatform/CLI/blob/main/package.json))
* [Conduit CLI](#conduit-cli)
* [Limitations](#limitations)
* [Usage](#usage)
* [Commands](#commands)
* [Roadmap](#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
```sh-session
$ 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 cli update`](#conduit-cli-update)
* [`conduit deploy rm`](#conduit-deploy-rm)
* [`conduit deploy setup`](#conduit-deploy-setup)
* [`conduit deploy start`](#conduit-deploy-start)
* [`conduit deploy stop`](#conduit-deploy-stop)
* [`conduit deploy update`](#conduit-deploy-update)
* [`conduit generateClient graphql`](#conduit-generateclient-graphql)
* [`conduit generateClient rest`](#conduit-generateclient-rest)
* [`conduit generateSchema [PATH]`](#conduit-generateschema-path)
* [`conduit help [COMMAND]`](#conduit-help-command)
* [`conduit init`](#conduit-init)
## `conduit cli update`
Update your CLI
```
USAGE
$ conduit cli update
DESCRIPTION
Update your CLI
```
## `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 ]
FLAGS
--config Enable manual deployment configuration
--target= 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 ]
FLAGS
--config Enable manual deployment configuration
--target= 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 ] [-p ]
FLAGS
-p, --output-path= Path to store archived library in
-t, --client-type= 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 ] [-p ]
FLAGS
-p, --output-path= Path to store archived library in
-t, --client-type= 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](https://github.com/ConduitPlatform/CLI/blob/v0.0.5/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](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
## `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](https://github.com/ConduitPlatform/CLI/blob/v0.0.5/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