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 and registry.
Commands
ls
List the children of a URL.
Usage
recap ls [OPTIONS] [URL]
Parameters
| Option | Type | Description | Default |
|---|---|---|---|
| URL | TEXT | URL to parent. | - |
Example
recap ls postgres://user:pass@localhost:5432/testdb
schema
Get the schema of a URL.
Usage
recap schema [OPTIONS] URL
Parameters
| Option | Type | Description | Default |
|---|---|---|---|
| URL | TEXT | URL to schema. | - |
| --output-format -of | TEXT | Schema output format. [avro|json|protobuf|recap] | recap |
Example
recap schema postgres://user:pass@localhost:5432/testdb/public/test_types
serve
Start Recap’s HTTP/JSON server.
Usage
recap serve [OPTIONS]
Parameters
| Option | Type | Description | Default |
|---|---|---|---|
--host | TEXT | Hostname to bind the server to. | 127.0.0.1 |
--port | TEXT | Port to bind the server to. | 8000 |
--log-level | TEXT | Log level for the server. | info |
Example
recap serve