@staff0rd/assist 0.870.3 → 0.871.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
@@ -40,7 +40,7 @@ After installation, the `assist` command will be available globally. You can als
40
40
 
41
41
  ## Claude Commands
42
42
 
43
- - `/add-command` - Add a new run command to assist.yml
43
+ - `/add-command` - Add a new run command via `assist run add`
44
44
  - `/add-rule` - Capture a new `CLAUDE.md` rule from a review comment
45
45
  - `/branch <description> [--jira KEY]` - Create a branch off the fresh remote default
46
46
  - `/bug` - File a bug with reproduction steps, expected and actual behavior
@@ -214,7 +214,7 @@ Backlog item ids are written in an `a`-prefixed form (e.g. item 555 is `a555`) t
214
214
  ### Config and run commands
215
215
 
216
216
  - `assist run <name> [params...]` - Run a configured command from assist.yml, or a backlog item (`a555` / `555`) when no command matches
217
- - `assist run add <name> <command> [args...] [--cwd <dir>] [--server [group]] [--port <port>] [--repo [name]]` - Add a new run configuration to assist.yml and create a Claude command file; `--server`/`--port` mark it as a dev server, and `--repo` writes it to the repo's shared db override instead (no command file)
217
+ - `assist run add <name> <command> [args...] [--cwd <dir>] [--server [group]] [--port <port>] [--env KEY=VALUE]... [--repo [name]]` - Add a new run configuration to assist.yml and create a Claude command file; `--server`/`--port` mark it as a dev server, `--env` sets an environment variable (repeatable), `--help` lists every run entry property, and `--repo` writes it to the repo's shared db override instead (no command file)
218
218
  - `assist run link <path> --prefix <prefix>` - Link run configurations from another project's assist.yml
219
219
  - `assist run remove <name> [--repo [name]]` - Remove a run configuration and delete its Claude command file; `--repo` removes it from the repo's shared db override instead
220
220
 
@@ -1,27 +1,27 @@
1
1
  ---
2
- description: Add a new run command to assist.yml
2
+ description: Add a new run command via assist run add
3
3
  allowed_args: "[description of the command to add]"
4
4
  ---
5
5
 
6
- The user wants to register a new run command via `assist run add`. This command adds a named entry to the `run` section of `assist.yml` so it can be invoked with `assist run <name>`.
6
+ The user wants to register a new run command via `assist run add`. This adds a named entry to the repo's `run` list — in `assist.yml`, or with `--repo [name]` in the repo's override in the shared db (seen by every node, no command file created) — so it can be invoked with `assist run <name>`.
7
7
 
8
8
  ## Step 1: Understand the request
9
9
 
10
10
  If the user provided a description via $ARGUMENTS, use that as a starting point. Otherwise, ask what command they want to add.
11
11
 
12
- ## Step 2: Determine the correct syntax
12
+ ## Step 2: Read the reference
13
13
 
14
- Run `assist run add --help` to see the current CLI usage and options. Use the output to construct the correct command.
14
+ Run `assist run add --help` before anything else. It lists every run entry property with its flag and is the complete reference: if a property is listed there, `assist run` supports it — don't work around it (e.g. with `cross-env` or a shell wrapper) or tell the user it's unsupported. Commands are spawned without a shell, so use `--env KEY=VALUE` for environment variables rather than `FOO=bar cmd`.
15
15
 
16
16
  ## Step 3: Add the command
17
17
 
18
- Run `assist run add <name> <command> [args...]` with the appropriate arguments. For example:
18
+ Run `assist run add <name> <command> [args...]` with the flags from the help. For example:
19
19
 
20
20
  ```
21
- assist run add lint oxlint --fix
21
+ assist run add dev npm run dev --cwd web --env API_URL=http://localhost:3000 --server --port 3000
22
22
  ```
23
23
 
24
- If the command needs a working directory, use `--cwd <dir>`. For a dev server, add `--server [group]` and optionally `--port <port>`. To share the entry across every node without touching the repo's `assist.yml`, add `--repo [name]` (writes the repo's shared db override; defaults to the current repo).
24
+ For properties the help marks "set in config", edit the entry in `assist.yml` directly after adding it.
25
25
 
26
26
  ## Step 4: Verify
27
27