ework-aio 0.1.3 → 0.1.4

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 +26 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -13,11 +13,21 @@ All-in-one installer for the **ework** self-hosted AI development stack:
13
13
  ## Quick start
14
14
 
15
15
  ```bash
16
- npm install -g ework-aio && ework-aio install
16
+ # Recommended: user-level install (no sudo needed)
17
+ npm install -g ework-aio --prefix ~/.local && ework-aio install
17
18
  ```
18
19
 
19
20
  That's the whole install. When it finishes it prints your login URL, operator login, and token.
20
21
 
22
+ > **PATH heads-up:** `--prefix ~/.local` puts bin shims at `~/.local/bin/`.
23
+ > Most distros already have `~/.local/bin` on PATH (via `systemd-user-sessions`
24
+ > or `~/.profile`). If `command -v ework-aio` fails after install, add this to
25
+ > your `~/.bashrc` / `~/.zshrc`:
26
+ >
27
+ > ```bash
28
+ > export PATH="$HOME/.local/bin:$PATH"
29
+ > ```
30
+
21
31
  ### Prerequisites
22
32
 
23
33
  The install command checks for these and aborts with a hint if any are missing:
@@ -30,19 +40,28 @@ The install command checks for these and aborts with a hint if any are missing:
30
40
  | `systemctl` | any | systemd-based Linux |
31
41
  | `openssl`/`curl`/`jq`/`awk` | any | your distro package manager |
32
42
 
33
- ### One-liner alternatives
43
+ ### Install variants
34
44
 
35
45
  ```bash
46
+ # System-level install (needs sudo; services run as root, units in /etc/systemd/system)
47
+ sudo npm install -g ework-aio && sudo ework-aio install --system
48
+
36
49
  # Run without installing globally (downloads + runs once)
37
50
  npx ework-aio install
38
51
 
39
- # If npm registry is slow on your machine, route through an HTTP proxy
40
- HTTPS_PROXY=http://127.0.0.1:7890 npm install -g ework-aio && ework-aio install
41
-
42
- # User-level install (no sudo) — uses ~/.local as npm prefix
43
- npm install -g ework-aio --prefix ~/.local && ework-aio install
52
+ # Route through an HTTP proxy if npm registry is slow on your machine
53
+ HTTPS_PROXY=http://127.0.0.1:7890 npm install -g ework-aio --prefix ~/.local && ework-aio install
44
54
  ```
45
55
 
56
+ User-level (default in this README) keeps everything under your home directory:
57
+
58
+ - bins: `~/.local/bin/`
59
+ - npm package files: `~/.local/lib/node/`
60
+ - data: `~/.local/share/ework-aio/`
61
+ - systemd units: `~/.config/systemd/user/`
62
+
63
+ `sudo` is never required; uninstall is `rm -rf ~/.local/share/ework-aio && npm uninstall -g ework-aio --prefix ~/.local`.
64
+
46
65
  ### Why two steps?
47
66
 
48
67
  `npm install -g ework-aio` **only** lays down files: the bin launcher and the bash installer. It does **not** run the installer. The second `ework-aio install` step is what actually:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ework-aio",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "All-in-one installer for ework (issue tracker) + ework-daemon (AI bridge) + opencode-ework (plugin). One command: npm i -g ework-aio && ework-aio install.",
5
5
  "type": "module",
6
6
  "license": "MIT",