@xevy/cli 0.1.6 → 0.1.7
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 +75 -4
- package/bin/xevy.mjs +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,69 @@
|
|
|
1
1
|
# @xevy/cli
|
|
2
2
|
|
|
3
|
-
The **`xevy`** command — set up and launch the [pi](https://github.com/badlogic/pi-mono) agent with Xevy.
|
|
3
|
+
The **`xevy`** command — set up and launch the [pi](https://github.com/badlogic/pi-mono) agent with Xevy, the free AI workspace for digital business.
|
|
4
|
+
|
|
5
|
+
New here? Follow **Get started** below from top to bottom — it takes about five minutes.
|
|
6
|
+
|
|
7
|
+
## Get started
|
|
8
|
+
|
|
9
|
+
### 1. Create your Xevy account
|
|
10
|
+
|
|
11
|
+
Xevy is free. Register (or log in if you already have an account) in the browser first:
|
|
12
|
+
|
|
13
|
+
- **Register:** <https://xevy.ai/register>
|
|
14
|
+
- **Log in:** <https://xevy.ai/login>
|
|
15
|
+
|
|
16
|
+
### 2. Make sure you have Node.js
|
|
17
|
+
|
|
18
|
+
The CLI runs on [Node.js](https://nodejs.org/) 18 or newer. Check what you have:
|
|
4
19
|
|
|
5
20
|
```bash
|
|
6
|
-
|
|
7
|
-
|
|
21
|
+
node --version # should print v18.x.x or higher
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
If the command isn't found or the version is too old, install the latest LTS from
|
|
25
|
+
<https://nodejs.org/> and try again. `npm` ships with Node, so you get it automatically.
|
|
26
|
+
|
|
27
|
+
### 3. Install the CLI
|
|
28
|
+
|
|
29
|
+
Install globally so the `xevy` command is available everywhere on your machine:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm install -g @xevy/cli
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
> Prefer not to install anything? You can run every command below with `npx @xevy/cli`
|
|
36
|
+
> instead of `xevy` — e.g. `npx @xevy/cli setup`. It's slower each run but installs nothing.
|
|
37
|
+
|
|
38
|
+
### 4. Run the one-time setup
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
xevy setup
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
This walks you through everything:
|
|
45
|
+
|
|
46
|
+
1. Installs the **pi agent** if it isn't already on your PATH.
|
|
47
|
+
2. Installs the Xevy extensions (see [`xevy setup`](#xevy-setup) for details).
|
|
48
|
+
3. Asks for your **API key**. When prompted, open the link it prints — it takes you
|
|
49
|
+
straight to **Settings → Profile → API keys** at
|
|
50
|
+
<https://xevy.ai/settings?section=profile&tab=api> — click **Create key**, copy the
|
|
51
|
+
key, and paste it back into the terminal. Your key is saved to
|
|
52
|
+
`~/.config/xevy/credentials` and never printed again.
|
|
53
|
+
|
|
54
|
+
### 5. Start working
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
xevy # open an interactive pi session with Xevy loaded
|
|
58
|
+
xevy "summarise this repo" # or send a one-off prompt
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
That's it — you're set up. The sections below are reference for when you need more detail.
|
|
62
|
+
|
|
63
|
+
## Upgrading
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
npm update -g @xevy/cli # or re-run: npm install -g @xevy/cli
|
|
8
67
|
```
|
|
9
68
|
|
|
10
69
|
## `xevy setup`
|
|
@@ -40,8 +99,20 @@ xevy "summarise this repo" # forwards the prompt to pi
|
|
|
40
99
|
-h, --help Show help
|
|
41
100
|
```
|
|
42
101
|
|
|
102
|
+
## Skills & MCP for other agents
|
|
103
|
+
|
|
104
|
+
`@xevy/cli` sets up the [pi](https://github.com/badlogic/pi-mono) agent. If you'd
|
|
105
|
+
rather use **Cursor, Claude Code, or one of [50+ other agents](https://github.com/vercel-labs/skills#supported-agents)**,
|
|
106
|
+
install the Xevy **SDLC skills** and the **Xevy MCP server** with the sibling
|
|
107
|
+
package instead:
|
|
108
|
+
|
|
43
109
|
```bash
|
|
44
|
-
|
|
110
|
+
npx @xevy/skills # skills + MCP, global by default
|
|
111
|
+
npx @xevy/skills --project # into the current repo instead
|
|
45
112
|
```
|
|
46
113
|
|
|
114
|
+
Then connect MCP over OAuth (Cursor: Settings → MCP → `xevy`; Claude Code: browser
|
|
115
|
+
sign-in on first use). See the [`@xevy/skills` README](../xevy-skills/README.md) for
|
|
116
|
+
the full command list, per-agent flags, and manual install steps.
|
|
117
|
+
|
|
47
118
|
Docs: <https://xevy.ai/docs/mcp>
|
package/bin/xevy.mjs
CHANGED
|
@@ -77,7 +77,11 @@ Options:
|
|
|
77
77
|
Examples:
|
|
78
78
|
npx @xevy/cli setup
|
|
79
79
|
npx @xevy/cli
|
|
80
|
-
|
|
80
|
+
|
|
81
|
+
Install globally to drop the npx prefix:
|
|
82
|
+
npm install -g @xevy/cli
|
|
83
|
+
xevy setup
|
|
84
|
+
xevy`);
|
|
81
85
|
}
|
|
82
86
|
|
|
83
87
|
function parseArgv(argv) {
|
package/package.json
CHANGED