runbrief 0.1.2 → 0.1.4

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 (3) hide show
  1. package/README.md +30 -3
  2. package/dist/cli.js +2341 -680
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -13,13 +13,13 @@ name used in the install command.
13
13
  Claude Code:
14
14
 
15
15
  ```sh
16
- claude mcp add --transport stdio --scope user brief -- npx -y runbrief@0.1.2
16
+ claude mcp add --transport stdio --scope user brief -- npx -y runbrief@^0.1.4
17
17
  ```
18
18
 
19
19
  Codex:
20
20
 
21
21
  ```sh
22
- codex mcp add brief -- npx -y runbrief@0.1.2
22
+ codex mcp add brief -- npx -y runbrief@^0.1.4
23
23
  ```
24
24
 
25
25
  Generic MCP configuration:
@@ -29,7 +29,10 @@ Generic MCP configuration:
29
29
  "mcpServers": {
30
30
  "brief": {
31
31
  "command": "npx",
32
- "args": ["-y", "runbrief@0.1.2"]
32
+ "args": ["-y", "runbrief@^0.1.4"],
33
+ "env": {
34
+ "BRIEF_CONNECTOR_DISTRIBUTION": "package"
35
+ }
33
36
  }
34
37
  }
35
38
  }
@@ -39,6 +42,11 @@ Brief works locally without an account. Connect a Brief workspace only when
39
42
  you want approved team context, derived scan sync, shared learnings, and hosted
40
43
  proof history.
41
44
 
45
+ The published setup uses the compatible patch range (`^0.1.4`). Each fresh MCP
46
+ start resolves the latest compatible connector patch, so routine fixes do not
47
+ require a reinstall. A new setup is needed only when a future release changes
48
+ the supported minor or major version.
49
+
42
50
  ## License and boundaries
43
51
 
44
52
  The local Brief Connector distributed in this package is licensed under
@@ -73,3 +81,22 @@ Local use does not require an account. The default connected mode syncs derived
73
81
  metadata and proof, not raw source text. Workspace owners and admins can export
74
82
  hosted workspace data; owners can delete a workspace without deleting repo-local
75
83
  `.brief` files, their authentication account, or other workspaces.
84
+
85
+ ## Connected setup without shared keys
86
+
87
+ The Brief web app creates a browser-authorized setup by default. The copied MCP
88
+ config contains a short-lived, single-use enrollment code, not a reusable API
89
+ key. On its first start, the connector exchanges that code over HTTPS and
90
+ stores the resulting credential at `~/.config/runbrief/credentials.json` (or
91
+ `BRIEF_CREDENTIALS_FILE`) with mode `0600`. The code cannot be reused or moved
92
+ to another machine after redemption.
93
+
94
+ To remove the local credential and pair again:
95
+
96
+ ```bash
97
+ npx -y runbrief@^0.1.4 cloud-logout
98
+ ```
99
+
100
+ The explicit `BRIEF_API_URL` + `BRIEF_API_KEY` environment path remains as an
101
+ approved legacy or CI fallback. Do not put either value in chat, tickets,
102
+ repository files, or hosted-agent prompts.