@currents/cmd 2.0.2 → 2.2.0

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 CHANGED
@@ -87,7 +87,7 @@ See [Cancel Runs on Workflow Cancellation](https://docs.currents.dev/getting-sta
87
87
 
88
88
  ## Capture a session as evidence
89
89
 
90
- `currents session` captures an agent or browser session, such as a bug before and after a fix. Each command needs an API key with write access; set it once as `CURRENTS_API_KEY`:
90
+ `currents session` captures an agent or browser session, such as a bug before and after a fix. Each command uses the record key, or an API key with write access when no record key is set. In CI, where `CURRENTS_RECORD_KEY` is already set, nothing else is needed; elsewhere, set an API key once as `CURRENTS_API_KEY`:
91
91
 
92
92
  ```sh
93
93
  export CURRENTS_API_KEY=<api-key>
@@ -163,6 +163,10 @@ npx currents skill --install --dir .claude/skills
163
163
 
164
164
  The skill is also in this repository, in `skills/currents-cli`: `npx skills add https://github.com/currents-dev/currents-reporter --skill currents-cli`.
165
165
 
166
+ ## Guides
167
+
168
+ `npx currents docs` lists the guides that ship with the package, such as the CI setup steps. `npx currents docs <topic>` prints one as Markdown. The guides are in [docs/](./docs).
169
+
166
170
  ## Troubleshooting
167
171
 
168
172
  Run the CLI command with the `--debug` argument or prefix it with `DEBUG="currents,currents:*"` to obtain detailed information about the command execution process. Keys are hidden in the debug output.