impel-cli 0.7.0 → 0.7.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 +66 -53
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -25,78 +25,91 @@ of the protected Store directory and launches it with tenant-specific Codex and
25
25
  browser profiles. Each approach keeps the user's normal app profile and
26
26
  signed-in account untouched.
27
27
 
28
- ## Install
28
+ ## Start here
29
29
 
30
- Requires Node.js 18 or newer. The same command works on macOS, Linux, and
31
- Windows (PowerShell):
30
+ You do not need GitHub access to install Impel. You need an Impel account and a
31
+ computer with Node.js installed. Node.js includes the small installer tool
32
+ called `npm` that installs Impel for you.
32
33
 
33
- ```sh
34
- npm install --global impel-cli
35
- ```
34
+ ### 1. Install Node.js and npm
36
35
 
37
- The installable package is intentionally public so Impel users do not need
38
- access to the private GitHub repository. It contains only this dependency-free
39
- CLI—no credentials, service secrets, or customer data. Installing it grants no
40
- Impel access: every protected operation still requires an Impel PAT and the
41
- gateway/control plane re-checks the user's live product access, scopes, and
42
- tenant membership.
36
+ If `node --version` and `npm --version` already print version numbers, skip to
37
+ the next step.
43
38
 
44
- Releases are published from the private repository with npm Trusted Publishing:
45
- the registry accepts a short-lived OIDC credential only from the pinned release
46
- workflow, so no long-lived npm token is stored in GitHub. npm also verifies the
47
- published tarball's advertised SHA-512 integrity during installation.
39
+ - **Mac or Windows:** visit [nodejs.org/download](https://nodejs.org/en/download),
40
+ choose the **LTS** installer, and accept the default installer options.
41
+ - **Linux:** follow Node's [official package-manager instructions](https://nodejs.org/en/download/package-manager)
42
+ for your distribution.
48
43
 
49
- Maintainers can exercise the Windows-specific paths from a Linux Docker engine
50
- with the real Windows Node binary and Wine's `cmd.exe` compatibility layer:
44
+ After installing Node.js, close and reopen Terminal (Mac/Linux) or PowerShell
45
+ (Windows), then check that it worked:
51
46
 
52
47
  ```sh
53
- docker build --platform linux/amd64 -f test/docker/windows-wine.Dockerfile -t impel-cli-windows-test .
54
- docker run --rm --platform linux/amd64 impel-cli-windows-test
48
+ node --version
49
+ npm --version
55
50
  ```
56
51
 
57
- The repository CI additionally runs the complete suite on `windows-latest`;
58
- that native job owns the hostile percent/caret npm-shim case that Wine does not
59
- faithfully emulate.
52
+ Both commands should print a version number. Impel needs Node.js 18 or newer.
53
+
54
+ ### 2. Install Impel
60
55
 
61
- ## Quickstart
56
+ In Terminal or PowerShell, run:
62
57
 
63
58
  ```sh
64
- impel setup # token → tenant → platform clients → verify
65
- impel claude # launch Claude Code with an isolated Impel profile
66
- impel codex # launch Codex with an isolated Impel profile
67
- impel update # later: update the CLI, apps, and skills in one command
59
+ npm install --global impel-cli
68
60
  ```
69
61
 
70
- `impel setup` walks through everything below in one command (create your PAT at
71
- `https://www.useimpel.com/settings/gateway`, paste it at the secure prompt, and
72
- the wizard does the rest). On Windows it installs either missing official vendor
73
- CLI from npm, prepares both tenant-isolated CLI profiles, installs the signed
74
- Claude and ChatGPT desktop apps with separate tenant profiles, and syncs skills.
75
- On macOS it installs the isolated desktop apps. The individual commands remain
76
- for piecemeal use:
62
+ This downloads the public Impel command-line app. It does **not** give anyone
63
+ access to your Impel account, workspace, or data.
64
+
65
+ ### 3. Connect your Impel account
66
+
67
+ 1. Open [Impel gateway settings](https://www.useimpel.com/settings/gateway).
68
+ 2. Create a Personal Access Token and copy it somewhere safe.
69
+ 3. Back in Terminal or PowerShell, run:
70
+
71
+ ```sh
72
+ impel setup
73
+ ```
74
+
75
+ 4. Paste the token when asked. The input is hidden, and Impel stores it only in
76
+ your local account configuration.
77
+ 5. Choose your organization when prompted and let the setup finish.
78
+
79
+ Your token is the key to your account. Never paste it into a chat, ticket, or
80
+ shared document.
81
+
82
+ ### 4. Start working
77
83
 
78
84
  ```sh
79
- impel auth # paste your PAT when prompted
80
- impel tenant list # see every organization available to this user
81
- impel tenant use impel # select the tenant for accounts, specialists, and history
82
- impel claude # launch Claude Code with an isolated Impel profile
83
- impel codex # launch Codex with an isolated Impel profile
84
- impel status # isolated-launcher readiness, native mode, and reachability
85
- impel doctor # make one synthetic request to each provider and measure routing/latency
86
-
87
- impel app install # install both isolated desktop app profiles
88
- impel app update # update vendor apps, configs, and supported models
89
- impel app open claude # open Claude Desktop with its isolated Impel profile
90
- impel app open codex # open ChatGPT/Codex Desktop with its isolated Impel profile
91
-
92
- # The normal `claude` and `codex` commands keep using your personal profiles.
85
+ impel claude # open an isolated Impel Claude Code session
86
+ impel codex # open an isolated Impel Codex session
87
+ impel status # check your connection and configuration
88
+ impel update # install the latest Impel CLI later
93
89
  ```
94
90
 
95
- Fresh `impel claude` profiles start on **Claude Opus 4.8 with 1M context** and
96
- also register **Claude Fable 5** in `/model`. You can choose a different
97
- persistent default there, or override one session with `--model`.
91
+ `impel setup` keeps your normal Claude and Codex profiles separate. On Mac and
92
+ Windows it also prepares the supported isolated desktop experiences. On Windows,
93
+ it installs missing official vendor command-line tools when needed. On Linux,
94
+ it prepares the isolated command-line workflow.
95
+
96
+ ### If something does not work
97
+
98
+ - **`npm` or `node` is not recognized:** install Node.js from the link above,
99
+ then close and reopen Terminal or PowerShell.
100
+ - **`impel` is not recognized:** close and reopen the terminal, then run
101
+ `npm install --global impel-cli` again.
102
+ - **Your token is rejected:** create a fresh token in Impel gateway settings and
103
+ run `impel setup` again.
104
+ - **You need a different organization:** run `impel tenant list`, then
105
+ `impel tenant use <organization>`.
106
+
107
+ The npm package is public so Impel users do not need access to the private
108
+ GitHub repository. The package contains no account credentials or service
109
+ secrets; the Impel gateway and control plane still enforce your token, product
110
+ access, scopes, and organization membership for every protected action.
98
111
 
99
- ## Commands
112
+ ## Command reference
100
113
 
101
114
  ```
102
115
  impel setup [--pat <pat>] [--tenant <org>] [--skip-apps] [--skip-clis]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "impel-cli",
3
- "version": "0.7.0",
3
+ "version": "0.7.1",
4
4
  "description": "Configure Claude Code and Codex CLI to talk to Impel's gateway, authenticated by an Impel Personal Access Token",
5
5
  "type": "module",
6
6
  "bin": {