@lovrabet/lovrabet-cli
v2.1.14
Published
Runtime CLI for Lovrabet apps, datasets, SQL, BFF, skills, and AI agent workflows.
Downloads
9,128
Readme
Lovrabet CLI
Lovrabet CLI is the runtime command-line interface for Lovrabet applications. It helps developers, delivery teams, operators, and AI agents work with published apps, datasets, records, SQL queries, BFF scripts, files, OCR, knowledge bases, artifacts, and runtime Skills from a stable terminal surface.
The CLI is designed for runtime operations: discover the right app, inspect data contracts, query real records, execute approved runtime capabilities, and turn repeatable workflows into agent-ready Skills.
Requirements
- Node.js 20 or later
- A Lovrabet account with access to the target runtime app
- A User Access Key for authenticated commands
Install
npm install -g @lovrabet/lovrabet-cli@latest
lovrabet --version
lovrabet --helpYou can also run a specific version with npm tooling:
npx @lovrabet/lovrabet-cli@latest --helpQuick Start
Authenticate first:
lovrabet auth login
lovrabet auth info --format compressFor non-interactive environments, pass an Access Key explicitly:
lovrabet auth login --access-key <ACCESS_KEY>List available runtime apps:
lovrabet app listBind the current workspace to an app, or pass --app / --appcode on each
command:
lovrabet workspace init --app <app-name>
lovrabet workspace init --appcode <app-code>Discover a dataset and inspect its contract before querying records:
lovrabet dataset list --name customer
lovrabet dataset detail --code <dataset-code>
lovrabet data filter --code <dataset-code> --params '{"currentPage":1,"pageSize":20}'Use --format pretty for human-readable output and --format json or
--format compress for scripts and agents.
AI Agent Skill
If your coding environment supports the skills CLI, install the Lovrabet CLI
Built-in Skill so the agent can follow the correct app resolution, dataset
inspection, data query, and risk-control workflow:
lovrabet cli-skill installEquivalent direct installation:
npx skills add lovrabet/lovrabet-cli -g -yAfter selecting an app, install app-specific business Skills when available:
lovrabet skill install
lovrabet skill install --scope personal
lovrabet skill install --scope companyCommon Commands
| Area | Commands |
| --- | --- |
| Authentication | lovrabet auth login, lovrabet auth info, lovrabet auth logout |
| App and workspace | lovrabet app list, lovrabet workspace init, lovrabet workspace use |
| Dataset discovery | lovrabet dataset list, lovrabet dataset detail, lovrabet dataset sdk-doc |
| Data operations | lovrabet data filter, lovrabet data getOne, lovrabet data create, lovrabet data update, lovrabet data delete, lovrabet data aggregate |
| SQL and BFF | lovrabet sql detail, lovrabet sql exec, lovrabet bff detail, lovrabet bff exec |
| Personal assets | lovrabet personal-bff list, lovrabet artifact list, lovrabet kb list |
| Runtime files and OCR | lovrabet file upload, lovrabet file query-url, lovrabet ocr recognize |
| Skills | lovrabet cli-skill install, lovrabet skill install, lovrabet skill create, lovrabet skill validate, lovrabet skill push |
| Diagnostics | lovrabet doctor, lovrabet schema, lovrabet logs show, lovrabet update |
Run command-level help for flags and prerequisites:
lovrabet <service> --help
lovrabet <service> <command> --helpOutput and Automation
Global options are available across commands:
lovrabet dataset list --format json
lovrabet data filter --code <dataset-code> --params '{"currentPage":1,"pageSize":10}' --jq '.data'
lovrabet data update --code <dataset-code> --params '{"id":1,"status":"done"}' --dry-runImportant options:
--app <name>: select an app profile by name--appcode <code>: override the target app code--env production|development|daily: choose the target environment--format json|pretty|compress: choose output format--jq <expr>: filter JSON output--dry-run: preview supported write operations--yes: skip confirmation for high-risk writes--non-interactive: force CI-friendly behavior
Safety Notes
- Inspect dataset contracts with
dataset detailbefore writing records. - Prefer read commands before write commands when diagnosing data issues.
- Use
--dry-runwhere supported before create, update, delete, artifact, personal BFF, or Skill operations. - Use
--yesonly when the target app, dataset, parameters, and impact are already verified. - Do not commit Access Keys, generated credentials, or local user config files.
Documentation
- Website: https://www.lovrabet.com
- Developer documentation: https://open.lovrabet.com/
- CLI help:
lovrabet --help
License
Licensed under Apache-2.0. See LICENSE and NOTICE for details.
