@phanthy/phanthy-code 0.1.0 → 0.1.2

package/README.md

@@ -8,7 +8,6 @@ phanthy code is a software engineering CLI owned and maintained by **phanthy gro
 
 - Copyright and ownership belong to phanthy group.
 - phanthy code is maintained as an independent phanthy group project.
-- The default API endpoint is `http://oneapi.4pd.io:3000`; set `PHANTHY_BASE_URL` to override it.
 
 ---
 
@@ -23,52 +22,58 @@ phanthy code is a CLI for performing software engineering tasks such as editing
 
 ---
 
-## Directory Structure
-
-```text
-src/
-├── main.tsx                 # Entrypoint orchestration (Commander.js-based CLI path)
-├── commands.ts              # Command registry
-├── tools.ts                 # Tool registry
-├── Tool.ts                  # Tool type definitions
-├── QueryEngine.ts           # LLM query engine
-├── context.ts               # System/user context collection
-├── cost-tracker.ts          # Token cost tracking
-│
-├── commands/                # Slash command implementations (~50)
-├── tools/                   # Agent tool implementations (~40)
-├── components/              # Ink UI components (~140)
-├── hooks/                   # React hooks
-├── services/                # External service integrations
-├── screens/                 # Full-screen UIs (Doctor, REPL, Resume)
-├── types/                   # TypeScript type definitions
-├── utils/                   # Utility functions
-│
-├── bridge/                  # IDE and remote-control bridge
-├── coordinator/             # Multi-agent coordinator
-├── plugins/                 # Plugin system
-├── skills/                  # Skill system
-├── keybindings/             # Keybinding configuration
-├── vim/                     # Vim mode
-├── voice/                   # Voice input
-├── remote/                  # Remote sessions
-├── server/                  # Server mode
-├── memdir/                  # Persistent memory directory
-├── tasks/                   # Task management
-├── state/                   # State management
-├── migrations/              # Config migrations
-├── schemas/                 # Config schemas (Zod)
-├── entrypoints/             # Initialization logic
-├── ink/                     # Ink renderer wrapper
-├── native-ts/               # Native TypeScript utilities
-├── outputStyles/            # Output styling
-├── query/                   # Query pipeline
-└── upstreamproxy/           # Proxy configuration
+## Installation
+
+Install Bun before using the CLI or working on the repository:
+
+```sh
+curl -fsSL https://bun.sh/install | bash
+```
+
+Install the published CLI with npm:
+
+```sh
+npm install -g @phanthy/phanthy-code
+```
+
+For local development, install repository dependencies with Bun:
+
+```sh
+bun install
+```
+
+---
+
+## Environment Variables
+
+Set authentication and service configuration through environment variables:
+
+```sh
+export PHANTHY_API_KEY="your-api-key"
+```
+
+`PHANTHY_API_KEY` is the developer-token path. When it is set, the CLI skips web
+login and calls `https://router.phanthy.com` by default.
+
+Without `PHANTHY_API_KEY`, the CLI signs in through `https://coding-plan.phanthy.com`
+and sends model API requests to Code with the stored OAuth access token.
+
+Useful endpoint overrides:
+
+```sh
+export PHANTHY_CODE_BASE_URL="http://localhost:3001"
+export PHANTHY_ROUTER_BASE_URL="https://router.phanthy.com"
+export PHANTHY_BASE_URL="https://your-phanthy-api.example.com"
 ```
 
+`PHANTHY_CODE_BASE_URL` points OAuth and normal logged-in API traffic at a local
+or alternate Code deployment. `PHANTHY_ROUTER_BASE_URL` overrides the API-key
+router endpoint. `PHANTHY_BASE_URL` is the strongest override and forces all
+first-party API traffic to a custom endpoint.
+
 ---
 
 ## Research / Ownership Disclaimer
 
 - This repository is owned and maintained by **phanthy group**.
-- phanthy code uses the phanthy API configuration by default.
+- phanthy code uses phanthy API configuration.