RAGfly CLI

Install ragfly-cli 1.21.0 to operate RAGfly from a terminal or CI job:

pip install ragfly-cli
ragfly login
ragfly cloud me
ragfly cloud entity set 000057
ragfly cloud entity set --clear
ragfly cloud area set FINANCE
ragfly cloud area set --release

Cloud commands call /v1; JSON output is the same English contract as REST and MCP. Human table labels and errors are English too.

Commands

ragfly
├── login / logout / version
└── cloud
    ├── me
    ├── group       list | switch | clear
    ├── entity      set [ENTITY_CODE] | set --clear
    ├── area        set [AREA_CODE] | set --release | list
    ├── location    list
    ├── api-key     create | list | revoke
    ├── document    list | show | edges
    ├── space       list | show | compose | read | refresh | promote
    ├── queue       show | runs
    ├── skill       list | show | run
    ├── catalog
    ├── document-type  list
    ├── characteristic list
    ├── search
    ├── chat        ask
    └── agent       context | tool

Legacy command and flag spellings, where still accepted, are input-only compatibility aliases. They are not part of the published contract, examples or machine-readable output; use the English command and flag names shown here.

Examples

export RAGFLY_API_KEY=rf_xxxxxxxxxx

ragfly cloud document list --status VECTORIZED --limit 20 -o json
ragfly cloud document show DOC-2024-001 -o json
ragfly cloud area list --limit 50 -o json
ragfly cloud location list --limit 50 -o json
ragfly cloud search "active maintenance contracts" --location LOC-DOCUMENTS -o json
ragfly cloud skill run SUMMARIZE_DOCUMENT --space 42 -o json
ragfly cloud agent context --profile user_chat -o json
ragfly cloud chat ask "What is the renewal date?" --location LOC-DOCUMENTS -o json
ragfly cloud chat ask "How do I release the entity focus of my key?" --mode help
ragfly cloud document-type list -o json
ragfly cloud search "statements" --filter @filter.json --space 42 -o json
ragfly cloud space compose difference 12 15 --name "Only in 12"

Machine-readable output uses public keys such as code, name, status, space_id, skill_code, answer and conversation_id. Standard failures use the English REST error envelope.

Authentication

Interactive login stores a JWT in the OS keyring. CI should use an API key via RAGFLY_API_KEY. See REST.md for the authorization header and MCP.md for fs.home_var / fs.relative_path and local-file resolution.

A signed-in person issues API keys. A fixed-entity key cannot change focus. A flexible key can select an authorized entity or clear focus with ragfly cloud entity set --clear; --release remains a compatibility alias. The server stores focus, so it persists across CLI invocations. See INTEGRATION.md for the shared key contract.

Area focus is also stored for API keys; releasing it keeps the current entity. Locations are temporary request filters. The --location flag on search, document list, and chat ask narrows that request to a visible folder tree.