CLI for the RightDocuments API. Crystal binary, distributed via Homebrew and GitHub Releases.
brew install aluminumio/tap/rightdocuments
Or download a binary from Releases.
rightdocuments login # OAuth device-flow login
rightdocuments whoami [-j]
rightdocuments entities [-j]
rightdocuments entities:create --name NAME --type llc --state DE [-j]
rightdocuments documents ENTITY_ID [-j]
rightdocuments import path/to/file.pdf --entity ENTITY_ID [-j]
rightdocuments skills # print agent/LLM usage guide
rightdocuments logout
Pass -j/--json on any data command for machine-readable output. Run rightdocuments skills for an end-to-end walkthrough an LLM/agent can consume directly.
shards install
shards build --release
./bin/rightdocuments --help
Environment variables:
| Variable | Default | Purpose |
|---|---|---|
RIGHTDOCUMENTS_URL |
https://app.rightdocuments.com |
API host (override for self-hosted or dev) |
RIGHTDOCUMENTS_CLIENT_ID |
(production app id) | OAuth client id |
Tokens are persisted in ~/.netrc.