@kainoa/simplybuild 0.1.0 → 0.1.2

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 +25 -23
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,24 +8,26 @@
8
8
  - Node.js 20+
9
9
  - `xcodebuildmcp` available in `PATH` (interactive runs can install it automatically)
10
10
 
11
- ## Install (local repo)
11
+ ## Install
12
12
 
13
13
  ```bash
14
- npm install
15
- npm run build
14
+ npm install -g @kainoa/simplybuild
16
15
  ```
17
16
 
18
- Run directly:
17
+ Then run:
19
18
 
20
19
  ```bash
21
- node dist/cli.js --help
20
+ simplybuild --help
21
+ sb --help
22
22
  ```
23
23
 
24
+ `sb` is the short alias and works for all the same commands as `simplybuild`.
25
+
24
26
  ## Usage
25
27
 
26
28
  ```bash
27
29
  simplybuild --help
28
- sb --help
30
+ simplybuild "screenager"
29
31
  simplybuild --device "iPhone 15"
30
32
  simplybuild --scheme MyApp
31
33
  simplybuild --list-devices
@@ -35,28 +37,28 @@ simplybuild --verbose
35
37
 
36
38
  ## Behavior
37
39
 
38
- - Auto-discovers `.xcworkspace`/`.xcodeproj` recursively from current directory.
39
- - If none are found, prompts to search parent directories.
40
+ - Auto-discovers `.xcworkspace` and `.xcodeproj` recursively from the current directory.
41
+ - Prompts to search parent directories if no containers are found.
40
42
  - Auto-discovers schemes with `xcodebuild -list -json`.
41
43
  - Falls back to interactive Clack selectors when target selection is required.
42
- - `--device` requires exact name match (case-insensitive).
43
- - Physical deployment asks for one-time confirmation per `{project, deviceId}` and remembers approval.
44
- - Remembers last successful project/scheme/target context.
45
- - Checks for `xcodebuildmcp` at startup and can auto-install it via `npm install -g xcodebuildmcp` in interactive mode.
46
-
47
- ## State file
44
+ - Requires exact `--device` name matching (case-insensitive).
45
+ - Prompts once per project/device pair before physical deployment.
46
+ - Checks for `xcodebuildmcp` at startup and can offer to install it in interactive mode.
48
47
 
49
- State is persisted at:
48
+ ## Contributing
50
49
 
51
- - `$XDG_STATE_HOME/simplybuild/state.json` (if `XDG_STATE_HOME` is set)
52
- - otherwise `~/.local/state/simplybuild/state.json`
50
+ For local development:
53
51
 
54
- Corrupt state files are automatically backed up as:
52
+ ```bash
53
+ npm install
54
+ npm run build
55
+ npm test
56
+ ```
55
57
 
56
- - `state.json.corrupt-<timestamp>`
58
+ Run from source:
57
59
 
58
- ## Notes
60
+ ```bash
61
+ node dist/cli.js --help
62
+ ```
59
63
 
60
- - `--watch` is intentionally not implemented in v1.
61
- - In non-interactive (no TTY) mode, commands fail fast when a prompt would be required.
62
- - In non-interactive mode, missing `xcodebuildmcp` fails with explicit install instructions.
64
+ Contributions are welcome. Anyone is free to open a PR on GitHub: https://github.com/notkainoa/SimplyBuild
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kainoa/simplybuild",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Smart iOS build and deploy CLI wrapper for xcodebuildmcp",
5
5
  "type": "module",
6
6
  "bin": {