@kleo.so/cli 1.1.0 → 1.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 +20 -3
- package/dist/kleo.js +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,14 +17,29 @@ You need Node.js version 18 or later. The server you connect to must have the MC
|
|
|
17
17
|
Most people do not need to install anything. If you have Node.js, you can run the CLI straight from npm:
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npx @kleo.so/cli login
|
|
21
|
-
npx @kleo.so/cli kb list
|
|
20
|
+
npx "@kleo.so/cli" login
|
|
21
|
+
npx "@kleo.so/cli" kb list
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
If you use the CLI often, install it once so that the `kleo` command is always available
|
|
24
|
+
If you use the CLI often, install it once so that the `kleo` command is always available.
|
|
25
|
+
|
|
26
|
+
On Windows, open PowerShell, Command Prompt, or Git Bash:
|
|
27
|
+
|
|
28
|
+
```powershell
|
|
29
|
+
npm install -g "@kleo.so/cli"
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Keep the quotes around `"@kleo.so/cli"` in PowerShell so it treats it as a package name. The quoted command also works in Command Prompt and Git Bash.
|
|
33
|
+
|
|
34
|
+
On macOS, open Terminal. On Linux, open your terminal:
|
|
25
35
|
|
|
26
36
|
```bash
|
|
27
37
|
npm install -g @kleo.so/cli
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Then sign in and check the connection on any operating system:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
28
43
|
kleo login
|
|
29
44
|
kleo whoami
|
|
30
45
|
```
|
|
@@ -35,6 +50,8 @@ If you are working inside this repository instead of the published package, run
|
|
|
35
50
|
|
|
36
51
|
Run `kleo login`. It opens your browser to Kleo's sign-in page (Clerk OAuth 2.1 with PKCE); once you approve, the CLI receives an access token and a refresh token and writes them to `~/.kleo/config.json` with permissions set so that only you can read it. Tokens refresh automatically as they expire — you only need to run `login` again if you explicitly `logout` or the session is revoked.
|
|
37
52
|
|
|
53
|
+
Keep the terminal open while you sign in and approve access in the browser. If the browser does not open, copy the full URL printed by `kleo login` into your browser. Wait for the terminal to confirm that you are signed in, then run `kleo whoami` to check the connection. If login times out, run `kleo login` again and use the new URL.
|
|
54
|
+
|
|
38
55
|
```bash
|
|
39
56
|
kleo login [--url https://app.kleo.so]
|
|
40
57
|
```
|