automata-cli 0.2.0 → 0.2.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.
Files changed (2) hide show
  1. package/README.md +67 -5
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -14,12 +14,74 @@ npm install -g automata-cli
14
14
  automata --help
15
15
  ```
16
16
 
17
- ## Commands
17
+ ---
18
18
 
19
- | Command group | Description | Docs |
20
- |---|---|---|
21
- | `automata config` | Configure the tool | [docs/config.md](docs/config.md) |
22
- | `automata git` | Git workflow helpers (requires `gh` CLI) | [docs/git.md](docs/git.md) |
19
+ ## `automata config`
20
+
21
+ Launch the interactive configuration wizard to select the remote environment type.
22
+
23
+ ```bash
24
+ automata config
25
+ ```
26
+
27
+ Configuration is saved to `.automata/config.json` in the current directory.
28
+
29
+ ### `automata config set type <value>`
30
+
31
+ Set the remote type non-interactively (useful in scripts or CI).
32
+
33
+ ```bash
34
+ automata config set type gh # GitHub (requires gh CLI)
35
+ automata config set type azdo # Azure DevOps
36
+ ```
37
+
38
+ ---
39
+
40
+ ## `automata git`
41
+
42
+ Git workflow helpers. Most commands require the [`gh` CLI](https://cli.github.com/) installed and authenticated. `publish-release` only requires `git`.
43
+
44
+ ### `automata git get-pr-info`
45
+
46
+ Show the pull request for the current branch, including CI check results.
47
+
48
+ ```bash
49
+ automata git get-pr-info # human-readable output
50
+ automata git get-pr-info --json # full PR object as JSON
51
+ ```
52
+
53
+ ### `automata git get-pr-comments`
54
+
55
+ List open (unresolved) review thread comments on the current branch's PR.
56
+
57
+ ```bash
58
+ automata git get-pr-comments # human-readable output
59
+ automata git get-pr-comments --json # JSON array output
60
+ ```
61
+
62
+ ### `automata git finish-feature`
63
+
64
+ Clean up a merged feature branch: checkout `develop`, pull latest, delete the local branch.
65
+
66
+ ```bash
67
+ automata git finish-feature
68
+ ```
69
+
70
+ Checks that the PR exists and is merged, the working tree is clean, and the remote tracking branch is gone before making any changes.
71
+
72
+ ### `automata git publish-release`
73
+
74
+ Execute the full GitFlow release sequence and push to `origin`. Only requires `git`.
75
+
76
+ ```bash
77
+ automata git publish-release # auto-detect version from master tag
78
+ automata git publish-release 2.0.0 # explicit version
79
+ automata git publish-release --dry-run # preview without executing
80
+ ```
81
+
82
+ When no version is given, the latest semver tag on `master` is detected and the minor segment is incremented (e.g. `1.2.0 → 1.3.0`).
83
+
84
+ ---
23
85
 
24
86
  ## Development
25
87
 
package/package.json CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "name": "automata-cli",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Automata CLI tool",
5
5
  "type": "module",
6
6
  "bin": {
7
7
  "automata": "./dist/index.js"
8
8
  },
9
9
  "files": [
10
- "dist"
10
+ "dist",
11
+ "README.md"
11
12
  ],
12
13
  "scripts": {
13
14
  "build": "tsup",