Important
Under active development. Not production-ready.
git clone https://github.com/inferadb/cli.git
cd cli
cargo build --release
# Binary: target/release/inferadbShell completions:
inferadb completion bash > ~/.local/share/bash-completion/completions/inferadb
inferadb completion zsh > ~/.zfunc/_inferadb
inferadb completion fish > ~/.config/fish/completions/inferadb.fishinferadb login # Authenticate
inferadb whoami # Check identity
inferadb check user:alice can_view document:readme # Check authorization
inferadb list-resources user:alice can_view # List accessible resources
inferadb relationships add document:readme#viewer@user:bobRun inferadb --help for the full command list. Key command groups:
| Group | Commands |
|---|---|
| Auth | login, logout, register, whoami |
| Queries | check, simulate, expand, explain-permission, list-resources, list-subjects |
| Data | relationships, export, import, stream, stats, what-changed |
| Schema | schemas (init, push, validate, test, diff, visualize, etc.) |
| Admin | account, orgs, tokens |
| Diagnostics | status, ping, doctor, health, jwks |
| Help | cheatsheet, templates, guide, shell |
| Dev | dev (doctor, start, stop, status, logs, reset) |
| Config | profiles, config, completion |
| Flag | Description |
|---|---|
@<profile> |
Use specific profile (e.g., @prod check ...) |
--org |
Override organization |
-v, --vault |
Override vault |
-o, --output |
Format: table, json, yaml, jsonl |
-q, --quiet |
Suppress non-essential output |
-y, --yes |
Skip confirmation prompts |
--debug |
Enable debug logging |
| Location | Purpose |
|---|---|
~/.config/inferadb/cli.yaml |
User configuration |
.inferadb-cli.yaml |
Project configuration |
| OS Keychain | Credentials |
# ~/.config/inferadb/cli.yaml
default_profile: production
profiles:
production:
url: https://api.inferadb.com
org: org_abc123
vault: vault_xyz789Environment variables: INFERADB_PROFILE, INFERADB_URL, INFERADB_ORG, INFERADB_VAULT, INFERADB_TOKEN, INFERADB_DEBUG, NO_COLOR
| Code | Meaning | Code | Meaning |
|---|---|---|---|
| 0 | Success | 5 | Not found |
| 1 | General error | 6 | Conflict |
| 2 | Invalid arguments | 7 | Rate limited |
| 3 | Auth required | 10 | Network error |
| 4 | Permission denied | 11 | Server error |
Authorization-specific (check command):
| Code | Meaning |
|---|---|
| 0 | Allowed |
| 20 | Denied |
| 21 | Indeterminate |
just # List available commands
just ci # Run all checks (fmt, lint, test, doc)
just test # Run tests
just lint # Run clippy
just fmt # Format codeSee CLAUDE.md for architecture details.
Join us on Discord for questions and discussions.
Dual-licensed under MIT or Apache 2.0.
