@brainervirus/workit-cli 2.0.2 → 2.1.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.
- package/README.md +36 -7
- package/dist/index.js +2337 -289
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](https://www.npmjs.com/package/@brainervirus/workit-cli)
|
|
5
5
|
[](../../LICENSE)
|
|
6
6
|
|
|
7
|
-
The workit CLI — an interactive Ink wizard that configures workit for OpenCode and
|
|
7
|
+
The workit CLI — an interactive Ink wizard that configures workit for OpenCode, Cursor, Codex and Pi, plus upgrade tooling and an offline installation doctor.
|
|
8
8
|
|
|
9
9
|
## Requirements
|
|
10
10
|
|
|
@@ -21,7 +21,9 @@ npx @brainervirus/workit-cli init
|
|
|
21
21
|
## Usage
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
|
-
workit init #
|
|
24
|
+
workit init # basic / advanced setup wizard
|
|
25
|
+
workit upgrade [--hosts=opencode,cursor,codex,pi] [--cli] [--apply --confirm] [--json]
|
|
26
|
+
workit launch <opencode|cursor|codex|pi> [--auto-upgrade] [-- host arguments]
|
|
25
27
|
workit doctor # offline installation health report
|
|
26
28
|
workit doctor --json # machine-readable report
|
|
27
29
|
workit <family> <action> [--payload <json|@file|->] [--task <id>] [--revision <uuid>] [--workspace-revision <uuid|null>] [--view full] [--actor <id>] [--confirm] [--json]
|
|
@@ -32,14 +34,41 @@ workit uninstall # remove host registrations (keeps ~/
|
|
|
32
34
|
workit # help
|
|
33
35
|
```
|
|
34
36
|
|
|
35
|
-
`workit init` guides you through:
|
|
37
|
+
`workit init` guides you through: detected host selection, basic global config (locale, timezone, branch policy), optional advanced commit policy, YouTrack, VCS, workspaces (scoped hosting/tracker/branch/commit rules, profiles and release tracks), and project hygiene files. The wizard is a TTY application — `workit init` requires an interactive terminal and prints guidance (exiting nonzero) when stdin is not a TTY.
|
|
36
38
|
|
|
37
39
|
Authenticate GitHub or GitLab with `gh auth login` or `glab auth login` before hosting actions; Workit does not need a second provider token file. `workit action` Git/hosting payloads accept `cwd` to target any checkout while task state stays in the session directory. Non-Git directories can host tasks for OS work; YouTrack keeps its own permanent token.
|
|
38
40
|
|
|
39
|
-
The platforms step
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
41
|
+
The platforms step lists all four supported hosts. Installed tools are selected
|
|
42
|
+
initially; absent tools are disabled. Select all available, clear all, or pick
|
|
43
|
+
individual hosts. Apply uses native Codex marketplace and Pi package commands,
|
|
44
|
+
OpenCode registration, and a managed Cursor plugin copy. Existing explicit/local
|
|
45
|
+
pins and unrelated host settings are preserved. Use `workit cutover` for legacy
|
|
46
|
+
migration.
|
|
47
|
+
|
|
48
|
+
Advanced workspace edits preserve existing custom fields. Narrow globs win over
|
|
49
|
+
broader matches independent of file order; equal-specificity ambiguity is
|
|
50
|
+
reported. A sample-checkout preview shows the selected scope and effective
|
|
51
|
+
policy source. GitHub and GitLab can both use YouTrack; GitHub Issues requires
|
|
52
|
+
GitHub. Inheritance removes an override instead of freezing global defaults.
|
|
53
|
+
|
|
54
|
+
`workit upgrade` previews targeted native package updates and known configuration
|
|
55
|
+
migrations. `--apply --confirm` backs up configuration, rejects stale previews,
|
|
56
|
+
and verifies the installed version. Local/exact pins are skipped; `--cli` also
|
|
57
|
+
updates an existing global npm CLI (`--hosts=none` targets only the CLI). For ephemeral use, invoke
|
|
58
|
+
`npx @brainervirus/workit-cli@latest`. JSONC OpenCode configuration currently
|
|
59
|
+
requires native inspection rather than automatic mutation.
|
|
60
|
+
|
|
61
|
+
OpenCode 2.0.21 cannot target a server plugin with its `plugin update` command
|
|
62
|
+
(verified in the official Docker image). Workit reports that limitation and
|
|
63
|
+
preserves the OpenCode registration; it never falls back to updating every
|
|
64
|
+
plugin or deleting caches. OpenCode package resolution remains host-owned.
|
|
65
|
+
Cursor, Codex and Pi use their supported scoped update paths.
|
|
66
|
+
|
|
67
|
+
`workit launch <host> --auto-upgrade -- <args>` performs optional upgrades before
|
|
68
|
+
launch. Stop other selected host instances first. Registry failure starts the
|
|
69
|
+
unchanged host with a warning; installer or verification failure prevents launch.
|
|
70
|
+
No startup hook updates an already loaded plugin, and no task-history migration
|
|
71
|
+
or host-permission change is performed.
|
|
43
72
|
|
|
44
73
|
`workit doctor` checks the offline installation health and exits nonzero when problems are found; `--json` prints the full report as JSON instead of the human-readable table.
|
|
45
74
|
|