Command Line Interface
Interacting with Recap from the command line.
Introduction
Recap ships with a command line interface (CLI). You can use it to manage configuration, browse systems, read schemas, and start Recap’s gateway server.
Commands
add
Add a system to the config.
Usage
recap add [OPTIONS] SYSTEM URL
Parameters
| Option | Type | Description | Default | Required |
|---|---|---|---|---|
| SYSTEM | TEXT | The name of the system. | YES | |
| URL | TEXT | URL for the system. | YES |
Example
recap add my_pg postgresql://user:pass@host:port/dbname
ls
List the children of a path.
Usage
recap ls [OPTIONS] [PATH]
Parameters
| Option | Type | Description | Default | Required |
|---|---|---|---|---|
| PATH | TEXT | Path to list children of. | / | YES |
Example
recap ls my_pg/testdb
remove
Remove a system from the config.
Usage
recap remove [OPTIONS] SYSTEM URL
Parameters
| Option | Type | Description | Default | Required |
|---|---|---|---|---|
| SYSTEM | TEXT | The name of the system. | YES |
Example
recap remove my_pg
schema
Get the schema of a path.
Usage
recap schema [OPTIONS] [PATH]
Parameters
| Option | Type | Description | Default | Required |
|---|---|---|---|---|
| PATH | TEXT | Path to get schema of. | / | YES |
Example
recap schema my_pg/testdb/public/my_table
serve
Start Recap’s HTTP/JSON gateway server. Uses uvicorn under the hood.
Usage
recap serve [OPTIONS]
Parameters
| Option | Type | Description | Default | Required |
|---|---|---|---|---|
--host | TEXT | Hostname to bind the server to. | / | YES |
--port | TEXT | Port to bind the server to. | 8000 | YES |
--log-level | TEXT | Log level for the server. | info | YES |
Example
recap serve