CLI Reference
Conduit's CLI facilitates deployment, development, and code generation.
Installation
- Native Package
- npm
sh <(curl -s https://getconduit.dev/bootstrap)
caution
Windows users should install through WSL.
npm install -g @conduitplatform/cli
Requirements
- Docker installed and configured (without sudo)
- Docker Compose (v2 recommended, v1 supported)
Commands
deploy
Deploy local Conduit instances using containers.
# Basic deployment
conduit deploy setup
# Interactive configuration
conduit deploy setup --config
# Specify version
conduit deploy setup --version v0.16.0
Options:
| Flag | Description |
|---|---|
--config | Interactive module selection |
--version | Target Conduit version |
generateClient
Generate API client libraries.
conduit generateClient --help
Supports REST and GraphQL APIs.
generateSchema
Generate TypeScript schema files from deployed schemas.
conduit generateSchema --help
Useful for custom module development.
Using with npx
Run commands without global installation:
npx @conduitplatform/cli deploy setup
npx @conduitplatform/cli generateClient --help
npx @conduitplatform/cli generateSchema --help
Examples
Quick Start
# Deploy latest Conduit with defaults
npx @conduitplatform/cli deploy setup
# Open Admin Panel
open http://localhost:8080
Custom Module Selection
npx @conduitplatform/cli deploy setup --config
# Follow interactive prompts to select:
# - Database type (MongoDB/PostgreSQL)
# - Additional modules
# - Basic configuration
Compatibility
caution
Some commands may not work on outdated Conduit deployments. Use matching CLI and Conduit versions.