@manfred-kunze-dev/backbone-cli 2.6.0-dev.4 → 2.7.0-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +78 -0
  2. package/package.json +2 -6
package/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Backbone CLI
2
+
3
+ A command-line interface for the [Backbone AI](https://backbone.manfred-kunze.dev) platform. Manage projects, schemas, extractions, documents, and more — straight from your terminal.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install -g @manfred-kunze-dev/backbone-cli
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ```bash
14
+ # Authenticate
15
+ backbone auth login
16
+
17
+ # Create a project
18
+ backbone projects create -n "My Project"
19
+
20
+ # Set it as default
21
+ backbone config set project <project-id>
22
+
23
+ # Define a schema and run an extraction
24
+ backbone schemas create -n "Invoice"
25
+ backbone extractions create --schema <id> -m gpt-4o --text "Invoice #123, Total: $500"
26
+ ```
27
+
28
+ The CLI is also available as `bb` for quick access — e.g. `bb projects list`.
29
+
30
+ ## Authentication
31
+
32
+ The CLI supports multiple authentication methods (highest priority first):
33
+
34
+ | Method | Example |
35
+ |--------|---------|
36
+ | CLI flags | `--api-key sk_... --base-url https://...` |
37
+ | Environment variables | `BACKBONE_API_KEY`, `BACKBONE_BASE_URL` |
38
+ | Local `.backbone` file | JSON file in the current directory |
39
+ | Config store | `~/.config/backbone/config.json` (set via `backbone auth login`) |
40
+
41
+ ```bash
42
+ backbone auth login # Interactive setup
43
+ backbone auth status # Verify credentials
44
+ backbone auth logout # Clear stored credentials
45
+ ```
46
+
47
+ ## Commands
48
+
49
+ | Command | Description |
50
+ |---------|-------------|
51
+ | `auth` | Login, logout, and check auth status |
52
+ | `config` | Get, set, and list configuration values |
53
+ | `projects` | List, create, update, and delete projects |
54
+ | `schemas` | Manage schemas, versions, labels, validation, and testing |
55
+ | `prompts` | Manage prompts, versions, labels, compilation, and testing |
56
+ | `extractions` | Create extractions (text, file, images), list, re-run, estimate tokens |
57
+ | `convert` | Convert documents (PDF, DOCX, images) to Markdown/text/HTML/JSON |
58
+ | `ai` | Chat completions and model listing via the LLM Gateway |
59
+ | `transcribe` | Transcribe audio files (mp3, wav, flac, ogg, etc.) |
60
+ | `providers` | Manage BYOK AI providers |
61
+ | `analytics` | View project usage analytics |
62
+ | `billing` | Check subscription tier and usage limits |
63
+
64
+ ### Global Options
65
+
66
+ | Flag | Description |
67
+ |------|-------------|
68
+ | `--api-key <key>` | Override the API key |
69
+ | `--base-url <url>` | Override the base URL (default: `https://backbone.manfred-kunze.dev/api`) |
70
+ | `--project <id>` | Override the project ID |
71
+ | `--json` | Output raw JSON instead of formatted tables |
72
+ | `--no-color` | Disable colored output |
73
+
74
+ For full command documentation, see the [Backbone docs](https://backbone.manfred-kunze.dev).
75
+
76
+ ## License
77
+
78
+ Proprietary — see [LICENSE](./LICENSE) for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@manfred-kunze-dev/backbone-cli",
3
- "version": "2.6.0-dev.4",
3
+ "version": "2.7.0-dev.1",
4
4
  "description": "CLI for the Backbone AI platform",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -40,11 +40,7 @@
40
40
  "registry": "https://registry.npmjs.org",
41
41
  "access": "public"
42
42
  },
43
- "repository": {
44
- "type": "git",
45
- "url": "https://gitlab.com/manfred-kunze-dev/backbone.git",
46
- "directory": "cli"
47
- },
43
+ "homepage": "https://backbone.manfred-kunze.dev",
48
44
  "files": [
49
45
  "dist/**/*.js",
50
46
  "dist/**/*.d.ts"