@phanthy/phanthy-code 0.1.32 → 0.1.34
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 +40 -17
- package/dist/cli.js +1455 -1453
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,19 +1,33 @@
|
|
|
1
1
|
# phanthy code
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> An AI-powered software engineering CLI by **phanthy group** — edit files, run commands, search codebases, and coordinate agent workflows from your terminal.
|
|
4
|
+
|
|
5
|
+
**🌐 Website: [code.phanthy.com](https://code.phanthy.com)** — sign up, manage your plan, and get your account before you start.
|
|
4
6
|
|
|
5
7
|
---
|
|
6
8
|
|
|
7
|
-
##
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
1. **Sign up** at **[code.phanthy.com](https://code.phanthy.com)** to create your account and activate a plan.
|
|
12
|
+
2. **Install** the CLI:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install -g @phanthy/phanthy-code
|
|
16
|
+
```
|
|
8
17
|
|
|
9
|
-
|
|
10
|
-
|
|
18
|
+
3. **Run it** — on first launch the CLI opens a browser to sign in through [code.phanthy.com](https://code.phanthy.com):
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
phanthy-code
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
That's it. Once you're signed in, the CLI is ready to use.
|
|
11
25
|
|
|
12
26
|
---
|
|
13
27
|
|
|
14
|
-
##
|
|
28
|
+
## What is phanthy code?
|
|
15
29
|
|
|
16
|
-
phanthy code is a CLI for performing software engineering tasks such as editing files, running commands, searching codebases, and coordinating workflows.
|
|
30
|
+
phanthy code is a CLI for performing software engineering tasks such as editing files, running commands, searching codebases, and coordinating workflows. It works hand-in-hand with the [code.phanthy.com](https://code.phanthy.com) platform, where you register, sign in, and manage your subscription.
|
|
17
31
|
|
|
18
32
|
- **Language**: TypeScript
|
|
19
33
|
- **Runtime**: Bun
|
|
@@ -44,21 +58,21 @@ bun install
|
|
|
44
58
|
|
|
45
59
|
---
|
|
46
60
|
|
|
47
|
-
##
|
|
61
|
+
## Authentication
|
|
62
|
+
|
|
63
|
+
The recommended path is to **[sign up at code.phanthy.com](https://code.phanthy.com)** and let the CLI handle login for you. On first run, the CLI signs in through `https://code.phanthy.com` and sends model API requests using the stored OAuth access token — no manual configuration required.
|
|
48
64
|
|
|
49
|
-
|
|
65
|
+
### Developer token (optional)
|
|
66
|
+
|
|
67
|
+
If you have a developer API key, you can skip web login:
|
|
50
68
|
|
|
51
69
|
```sh
|
|
52
70
|
export PHANTHY_API_KEY="your-api-key"
|
|
53
71
|
```
|
|
54
72
|
|
|
55
|
-
`PHANTHY_API_KEY` is the
|
|
56
|
-
login and calls `https://router.phanthy.com` by default.
|
|
57
|
-
|
|
58
|
-
Without `PHANTHY_API_KEY`, the CLI signs in through `https://code.phanthy.com`
|
|
59
|
-
and sends model API requests to Code with the stored OAuth access token.
|
|
73
|
+
When `PHANTHY_API_KEY` is set, the CLI skips web login and calls `https://router.phanthy.com` by default.
|
|
60
74
|
|
|
61
|
-
|
|
75
|
+
### Endpoint overrides (advanced)
|
|
62
76
|
|
|
63
77
|
```sh
|
|
64
78
|
export PHANTHY_CODE_BASE_URL="http://localhost:3001"
|
|
@@ -73,7 +87,16 @@ first-party API traffic to a custom endpoint.
|
|
|
73
87
|
|
|
74
88
|
---
|
|
75
89
|
|
|
76
|
-
##
|
|
90
|
+
## Links
|
|
91
|
+
|
|
92
|
+
- 🌐 **Website / Sign up**: [code.phanthy.com](https://code.phanthy.com)
|
|
93
|
+
- 📦 **npm**: [@phanthy/phanthy-code](https://www.npmjs.com/package/@phanthy/phanthy-code)
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Ownership
|
|
77
98
|
|
|
78
|
-
-
|
|
79
|
-
- phanthy code uses phanthy API configuration.
|
|
99
|
+
- Copyright and ownership belong to **phanthy group**.
|
|
100
|
+
- phanthy code is maintained as an independent phanthy group project that uses phanthy API configuration.
|
|
101
|
+
</content>
|
|
102
|
+
</invoke>
|