# Constructive CLI
> API Server and Development Tools for PostgreSQL
Constructive CLI provides GraphQL server capabilities and code generation tools for PostgreSQL databases. For database migrations, packages, and deployment operations, use [pgpm](https://pgpm.io).
## Installation
```bash
npm install -g @constructive-io/cli
```
## Commands
### `cnc server`
Start the GraphQL development server.
```bash
# Start with defaults (port 5555)
cnc server
# Custom port and options
cnc server --port 8080 --no-postgis
# With custom CORS origin
cnc server --origin http://localhost:3000
```
**Options:**
- `--port ` - Server port (default: 5555)
- `--origin ` - CORS origin URL
- `--simpleInflection` - Use simple inflection (default: true)
- `--oppositeBaseNames` - Use opposite base names (default: false)
- `--postgis` - Enable PostGIS extension (default: true)
- `--metaApi` - Enable Meta API (default: true)
### `cnc explorer`
Launch GraphiQL explorer for your API.
```bash
# Launch explorer
cnc explorer
# With custom CORS origin
cnc explorer --origin http://localhost:3000
```
**Options:**
- `--port ` - Server port (default: 5555)
- `--origin ` - CORS origin URL (default: http://localhost:3000)
- `--simpleInflection` - Use simple inflection (default: true)
- `--oppositeBaseNames` - Use opposite base names (default: false)
- `--postgis` - Enable PostGIS extension (default: true)
### `cnc codegen`
Generate TypeScript types, operations, and SDK from a GraphQL schema or endpoint.
```bash
# Generate React Query hooks from endpoint
cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --react-query
# Generate ORM client from endpoint
cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --orm
# Generate both React Query hooks and ORM client
cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --react-query --orm
# From schema file
cnc codegen --schema-file ./schema.graphql --output ./codegen --react-query
# From database with schemas
cnc codegen --schemas public,app_public --output ./codegen --react-query
# From database with API names
cnc codegen --api-names my_api --output ./codegen --orm
```
**Options:**
- `--config ` - Path to config file
- `--endpoint ` - GraphQL endpoint URL
- `--schema-file ` - Path to GraphQL schema file
- `--schemas ` - Comma-separated PostgreSQL schemas
- `--api-names ` - Comma-separated API names
- `--react-query` - Generate React Query hooks
- `--orm` - Generate ORM client
- `--output ` - Output directory (default: ./codegen)
- `--authorization ` - Authorization header value
- `--browser-compatible` - Generate browser-compatible code (default: true)
- `--dry-run` - Preview without writing files
- `--verbose` - Verbose output
### `cnc codegen --schema-enabled`
Export GraphQL schema SDL without running full code generation. Works with any source (endpoint, file, database, PGPM).
```bash
# From database schemas
cnc codegen --schema-enabled --schemas myapp,public --schema-output ./schemas
# From running server
cnc codegen --schema-enabled --endpoint http://localhost:3000/graphql --schema-output ./schemas
# From schema file (useful for converting/validating)
cnc codegen --schema-enabled --schema-file ./input.graphql --schema-output ./schemas
# From a directory of .graphql files (multi-target)
cnc codegen --schema-enabled --schema-dir ./schemas --schema-output ./exported
# Custom filename
cnc codegen --schema-enabled --endpoint http://localhost:3000/graphql --schema-output ./schemas --schema-filename public.graphql
```
**Options:**
- `--schema-enabled` - Enable schema SDL export
- `--schema-output ` - Output directory for the exported schema file
- `--schema-filename ` - Filename for the exported schema (default: schema.graphql)
- `--endpoint ` - GraphQL endpoint URL
- `--schema-file ` - Path to GraphQL schema file
- `--schemas ` - Comma-separated PostgreSQL schemas
- `--api-names ` - Comma-separated API names (multi-target when >1)
- `--schema-dir ` - Directory of .graphql files (auto-creates one target per file)
- `--output ` - Output directory (default: ./generated/graphql)
- `--authorization ` - Authorization header value
## Configuration
### Environment Variables
Constructive respects standard PostgreSQL environment variables:
```bash
export PGHOST=localhost
export PGPORT=5432
export PGDATABASE=myapp
export PGUSER=postgres
export PGPASSWORD=password
```
## Database Operations
For database migrations, packages, and deployment, use **pgpm**:
```bash
npm install -g pgpm
```
Common pgpm commands:
- `pgpm init workspace` - Initialize a new workspace
- `pgpm init` - Create a new module
- `pgpm add ` - Add a database change
- `pgpm deploy` - Deploy database changes
- `pgpm verify` - Verify database state
- `pgpm revert` - Revert database changes
See the [pgpm documentation](https://pgpm.io) for more details.
## Getting Help
```bash
# Global help
cnc --help
# Command-specific help
cnc server --help
cnc codegen -h
```
## Global Options
- `--help, -h` - Show help information
- `--version, -v` - Show version information
- `--cwd ` - Set working directory