bisque-cli 0.2.2
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.
- package/README.md +110 -0
- package/dist/index.js +4737 -0
- package/package.json +53 -0
package/README.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# @bisque/cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for Bisque. Installs as the `bisque` binary.
|
|
4
|
+
|
|
5
|
+
The agent-facing reference (with flag tables and example payloads) lives at [`../skills/shared/references/cli-reference.md`](../skills/shared/references/cli-reference.md). This README is a quick installation + command-list summary; treat the skill reference as authoritative.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# From repo root
|
|
11
|
+
pnpm install
|
|
12
|
+
pnpm build
|
|
13
|
+
|
|
14
|
+
cd packages/cli
|
|
15
|
+
npm link # exposes the `bisque` binary globally
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Authentication
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
bisque auth login # Opens browser, exchanges Clerk session for a persistent API key
|
|
22
|
+
bisque auth status # Prints user, key prefix, endpoint
|
|
23
|
+
bisque auth logout
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Credentials live in `~/.bisque/config.json`. The login flow uses a short-lived auth code (`POST /v1/auth/codes` → `POST /v1/auth/exchange`); the API key never appears in a URL.
|
|
27
|
+
|
|
28
|
+
To point at a non-default endpoint:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
bisque config set apiEndpoint http://localhost:3000 # local backend
|
|
32
|
+
# Production endpoint is baked in; no flag needed for hosted use.
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Command Index
|
|
36
|
+
|
|
37
|
+
### Documents
|
|
38
|
+
- `bisque add <file>` — upload (default `0-Inbox/`); flags: `--project|--area|--resource <name>`, `--tags`, `--filepath`, `--content`, `--title`, `--metadata <json>`
|
|
39
|
+
- `bisque bulk-add <pattern>` — upload multiple files
|
|
40
|
+
- `bisque get <id> [-o file.md]` — fetch document by UUID
|
|
41
|
+
- `bisque update <id>` — flags: `--title`, `--content`, `--tags`, `--keywords`, `--metadata`
|
|
42
|
+
- `bisque delete <id>`
|
|
43
|
+
- `bisque list` — list documents (supports `--path-prefix`, `--filepath`, `--workspace`)
|
|
44
|
+
- `bisque ls [path]` / `bisque tree [path]` — filesystem-style views
|
|
45
|
+
- `bisque search <query>` — keyword search; flags include `--category`, `--tags`
|
|
46
|
+
- `bisque move <id> <new-path>`
|
|
47
|
+
- `bisque link <id> <linked-ids...>`
|
|
48
|
+
- `bisque tag <id> <tags...>`
|
|
49
|
+
|
|
50
|
+
### Tasks + chains
|
|
51
|
+
- `bisque task create|list|get|update|claim|delete`
|
|
52
|
+
- `task update` supports `--chain-order <num>` (fractional values allowed)
|
|
53
|
+
- `bisque chain create|list|get|update`
|
|
54
|
+
- `bisque batch <ops.json>` — apply a batch of CRUD operations
|
|
55
|
+
|
|
56
|
+
### Agent personas
|
|
57
|
+
- `bisque persona list|get|create|update|delete`
|
|
58
|
+
- `bisque persona add-learning <id> <text>`
|
|
59
|
+
- `bisque persona add-feedback <id> <text>`
|
|
60
|
+
- `bisque agents refresh <path>` — regenerate `AGENTS.md` for a workspace directory
|
|
61
|
+
|
|
62
|
+
### Workspace + maintenance
|
|
63
|
+
- `bisque workspace list|get|default`
|
|
64
|
+
- `bisque inbox list`
|
|
65
|
+
- `bisque manifest` — workspace summary
|
|
66
|
+
- `bisque recall "<topic>"` — context-based retrieval
|
|
67
|
+
- `bisque maintenance` — workspace health analysis + mechanical fixes
|
|
68
|
+
- `bisque load "<project>"` — load AGENTS.md + frontmind for a project
|
|
69
|
+
- `bisque plugin install [--force]` — register the Claude Code plugin
|
|
70
|
+
- `bisque config show|get|set <key> [value]`
|
|
71
|
+
|
|
72
|
+
## Output formats
|
|
73
|
+
|
|
74
|
+
Most read commands accept `--json` for scripting:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
bisque list --json | jq '.[] | select(.tags | contains(["urgent"]))'
|
|
78
|
+
bisque workspace list --json
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Exit codes
|
|
82
|
+
|
|
83
|
+
| Code | Meaning |
|
|
84
|
+
|---|---|
|
|
85
|
+
| 0 | Success |
|
|
86
|
+
| 1 | General error (network, validation) |
|
|
87
|
+
| 2 | Authentication error (re-run `bisque auth login`) |
|
|
88
|
+
| 3 | Resource not found |
|
|
89
|
+
|
|
90
|
+
## Configuration file
|
|
91
|
+
|
|
92
|
+
`~/.bisque/config.json`:
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"apiEndpoint": "https://api.bisquelayer.com",
|
|
97
|
+
"apiKey": "bsk_..."
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
`apiEndpoint` is normalized to a bare origin (no trailing `/v1`, no trailing slash) — route paths handle their own `/v1/...` prefix.
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
pnpm dev # tsx watch
|
|
107
|
+
pnpm build # tsc
|
|
108
|
+
pnpm test # vitest
|
|
109
|
+
pnpm lint # biome
|
|
110
|
+
```
|