CLI Reference

note

The Apiary CLI is minimal in v1. Most operations are performed through the Python SDK. A more complete CLI is planned for v2.

Installation

The CLI is built as part of the Rust workspace:

cargo build --workspace --release

The binary is located at target/release/apiary-cli.

In v1, the CLI binary prints version information and directs users to the Python SDK:

apiary-cli

apiary v1.0.0
CLI not yet implemented. Use the Python SDK.
See: https://apiarydata.github.io/apiary-docs/docs/reference/python-sdk

All data operations, queries, and cluster management are performed through the Python SDK.

Planned for v2

The following commands are planned for the v2 release. They are listed here to preview the intended CLI surface.

Start an Apiary node.

apiary start [OPTIONS]

Option	Description	Default
`--storage <URI>`	Storage backend URI	Local filesystem (`~/.apiary/data/`)
`--name <NAME>`	Apiary instance name	`default`

Execute a SQL query against a running Apiary instance.

apiary sql "<QUERY>"

Open an interactive SQL shell.

apiary shell [OPTIONS]

Option	Description	Default
`--storage <URI>`	Storage backend URI	Local filesystem