# phanthy code

phanthy code is a software engineering CLI owned and maintained by **phanthy group**.

---

## Ownership

- Copyright and ownership belong to phanthy group.
- phanthy code is maintained as an independent phanthy group project.

---

## Repository Scope

phanthy code is a CLI for performing software engineering tasks such as editing files, running commands, searching codebases, and coordinating workflows.

- **Language**: TypeScript
- **Runtime**: Bun
- **Terminal UI**: React + [Ink](https://github.com/vadimdemedes/ink)
- **Scale**: ~1,900 files, 512,000+ lines of code

---

## 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://code.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 phanthy API configuration.
