# Fuxi (fuxicodex/Fuxi)

> A fast terminal AI coding agent written in Go. It reads your code, edits files, runs commands and calls tools from a TUI, routing requests across LLM providers with cost awareness.

- GitHub: https://github.com/fuxicodex/Fuxi
- GitHub.Locker page: https://github.locker/fuxicodex/Fuxi
- Stars: 3.2K
- Language: Python
- Last push: 2026-10-20

## Questions and answers

Written by GitHub.Locker from the README and the repository; check the README below for details.

**Is it a chatbot or an agent that touches my files?**

An agent. It reads and edits your code, runs shell commands and drives tools, but sensitive tool calls ask for approval unless you change the permission mode.

**How do I get it running?**

Run the install command for your OS from the README, then type 'fuxi' to launch. Install and upgrade use the same command. Sign in with 'fuxi login', or use 'fuxi setup-token' for headless or CI setups.

**Do I need Python or Node installed first?**

No. It ships as one static binary with no runtime dependencies.

**Can it run commands without asking me first?**

Only if you start it with --dangerously-skip-permissions, which runs tool calls without prompts. The README says to use that only in a container or VM. Extreme commands like rm -rf / are still blocked, and root or sudo is rejected on Linux and macOS.

**Which operating systems does it support?**

macOS, Linux and Windows, with install commands given for each. On Windows the README lists both PowerShell and CMD.

**What happens to my code and conversations?**

By default FuXi does not collect or retain them. With your own key they go straight to your provider, and with managed models only to serve the request. Content reaches FuXi only if you enable sendconversations, which is off by default. Credentials stay in ~/.fuxi/.

**Is it open source?**

No. The product is proprietary. The public repository hosts only documentation, installers and the issue tracker, which accept contributions.

**Was FuXi itself built with an AI coding agent?**

The README says roughly 2 million lines of code were written entirely by FuXi itself.

**Can I use my own model provider instead of FuXi's?**

Yes. Set an API key via an environment variable or in ~/.fuxi/config.yaml. 'fuxi init' generates a template and 'fuxi wizard' guides the setup.

**Which slash commands should I learn first?**

/model switches models, /help lists all commands, /config opens settings, /privacy-settings sets privacy controls and /exit quits.

**Can I run it in CI without an interactive login?**

Yes. Use 'fuxi setup-token' for headless and CI environments instead of the interactive sign-in.


---

## README (checked against GitHub 2026-11-18)

Source: https://github.com/fuxicodex/Fuxi/blob/main/README.md

# FuXi

[English](README.md) | [简体中文](README.zh-CN.md)

[![GitHub stars](https://img.shields.io/github/stars/fuxicodex/Fuxi?style=flat-square&color=0a6fe7&label=stars)](https://github.com/fuxicodex/Fuxi/stargazers)
[![Release](https://img.shields.io/github/v/release/fuxicodex/Fuxi?style=flat-square&color=0a6fe7&label=release)](https://github.com/fuxicodex/Fuxi/releases)
[![Last commit](https://img.shields.io/github/last-commit/fuxicodex/Fuxi?style=flat-square&color=0a6fe7)](https://github.com/fuxicodex/Fuxi/commits/main)
[![License](https://img.shields.io/badge/license-Proprietary-0a6fe7?style=flat-square)](LICENSE)

FuXi is a fast, self-contained **terminal AI coding agent**. It reads code, edits
files, runs commands, and drives tools from a rich TUI, with cost-aware routing
across LLM providers and automatic failover. Built in Go, it ships as one static
binary with no runtime dependencies.

**Terminal-first** · **Provider-agnostic** · **Bring your own key** · **MCP client** · **Self-updating**

Homepage: **https://www.fuxicode.com**

FuXi's roughly **2 million lines of code** were written entirely by FuXi itself.

![FuXi in action](docs/fuxi-demo.gif)

## Install

**macOS / Linux**

```bash
curl -fsSL https://downloads.fuxicode.com/bootstrap.sh | bash
```

**Windows (PowerShell)**

```powershell
irm https://downloads.fuxicode.com/bootstrap.ps1 | iex
```

**Windows (CMD)**

```bat
curl -fsSL https://downloads.fuxicode.com/install.cmd -o "%TEMP%\fuxi-install.cmd" && "%TEMP%\fuxi-install.cmd"
```

Then verify and launch:

```bash
fuxi --version
fuxi doctor    # environment sanity checks
fuxi           # start a session
```

Install and upgrade are the same command. Full options, uninstall steps, and
troubleshooting: [setup docs](docs/usage.md#installation).

## Get started

A FuXi account is required. Run `fuxi`, then:

1. **Register and sign in** — `fuxi login` (or `fuxi setup-token` for
   headless/CI). Registration processes only minimal account data.
2. **Connect a model (optional)** — sign-in gives access to FuXi-managed models;
   to use your own provider instead, set an API key via environment variable or
   `~/.fuxi/config.yaml` (`fuxi init` generates a template). Or run `fuxi wizard`.

Then type a prompt and press Enter, for example:

```text
Fix the failing tests in this repository.
```

Useful commands: `/model` switch models · `/help` browse all commands ·
`/config` open settings · `/privacy-settings` privacy controls · `/exit` quit.

Full walkthrough: [usage guide](docs/usage.md).

## Permissions

Sensitive tool calls ask for approval unless you change the permission mode
at launch.

`--dangerously-skip-permissions` starts in `bypassPermissions`, so tool calls
run without a prompt. Extreme commands such as `rm -rf /` are still blocked.
Use it only in a container or VM; on Linux and macOS, root and `sudo` are
rejected.

`--allow-dangerously-skip-permissions` keeps the normal mode and adds
`bypassPermissions` to the `Shift+Tab` cycle.

`--permission-mode bypassPermissions` behaves like
`--dangerously-skip-permissions`. The same flag also accepts `default` and
`plan`.

## Data, privacy, and retention

FuXi runs on your machine and keeps your work local.

- **By default, your code and conversations are never collected, stored, or
  retained by FuXi.** With your own key they go straight to the provider you
  choose; with FuXi-managed models they are transmitted only to serve that
  request. Conversation content is sent to FuXi only if you explicitly enable
  `send_conversations` (off by default).
- **Credentials stay in local `~/.fuxi/`** and are never uploaded.
- **Sessions, checkpoints, memory, and audit logs** live on your device and can
  be deleted at any time by removing the config directory.
- FuXi processes limited account and technical information to operate the
  service; the available analytics are disclosed and can be turned off. See
  [Privacy Controls](security-privacy/DATA_PROTECTION.md).

Full details: [Privacy Policy](security-privacy/PRIVACY_POLICY.md) ·
[Security Whitepaper](security-privacy/SECURITY.md) ·
[Terms of Service](security-privacy/TERMS_OF_SERVICE.md).

## Documentation

| Guide | What it covers |
|---|---|
| [Usage guide](docs/usage.md) | First session, permissions, sessions & memory, tools & MCP, CLI reference, troubleshooting |
| [Architecture](docs/architecture.md) | Execution base, persistence, routing, multi-window coordination, extensibility |
| [Keyboard shortcuts](docs/keybindings.md) | Terminal-UI key reference |
| [Environment variables](docs/environment.md) | Full environment-variable reference |
| [FAQ](docs/faq.md) | Common questions |
| [Benchmark report](benchmark/REPORT.md) | Reproducible evaluation methodology and results |
| [Security & privacy](security-privacy/README.md) | Privacy Policy, Security Whitepaper, Terms of Service, Usage Policy, compliance and governance |
| [Changelog](CHANGELOG.md) | Release history |
| [Support](SUPPORT.md) | Where to get help |

## Usage policy

**You must use FuXi in accordance with the laws applicable to you.** FuXi is
aimed at developers and professional users and is not directed at children under
14; users aged 14–17 require a parent or guardian.

Disallowed uses and full requirements:
[Usage Policy](security-privacy/USAGE_POLICY.md). If you are unsure
whether a use is lawful, take advice before proceeding.

## Contributing

The product source is proprietary; this repository hosts the documentation,
installers, and issue tracker, which are open to contributions. See
[CONTRIBUTING.md](CONTRIBUTING.md).

## License

**Proprietary.** Copyright © 2026 FUXI. All rights reserved.

