fxrs-auth 0.0.4

Provider-neutral credential storage and authentication orchestration for fxrs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# fxrs

[![CI](https://github.com/Leeeon233/fx-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Leeeon233/fx-rs/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)

fxrs is a compact Rust rewrite of
[vercel-labs/fx](https://github.com/vercel-labs/fx). It preserves the
coding-agent semantics reachable through ACP while keeping providers,
authentication, tools, persistence, and host effects behind independent
boundaries.

It includes a fast full-screen terminal interface and an ACP stdio server. The
TUI is itself an ACP client, so interactive use and editor integrations share
the same provider, authentication, session, tool, and permission semantics.

## Quick start

Start the terminal interface in the current workspace:

```sh
fxrs
```

`Enter` sends a prompt, `Shift+Enter` inserts a newline, `Esc` cancels an
active turn, `Ctrl+M` selects a model, and `Shift+Tab` cycles the session mode.
Use `/help` for the complete keyboard and command reference. Notable commands
include `/login`, `/model`, `/mode`, `/resume`, `/new`, `/clear`, and `/quit`.

The interface streams Markdown responses and reasoning, updates tool cards in
place, provides foldable scrollback, queues follow-up prompts, and presents ACP
permission requests as keyboard- and mouse-operable cards. Set `NO_COLOR=1`
for a monochrome theme.

The focus, scrollback, and contextual-permission interactions take inspiration
from [xAI's grok-build](https://github.com/xai-org/grok-build); fxrs keeps its
implementation and runtime architecture independent.

## Install

Install the complete command set from crates.io:

```sh
cargo install fxrs --locked
```

Prebuilt archives are also available from
[GitHub Releases](https://github.com/Leeeon233/fx-rs/releases). Both methods
install the same four executables, which must remain in the same directory:

```text
fxrs
fx-tui
fx-acp
fx-terminal-host
```

`fx-tui` is the interactive frontend. `fx-acp` and `fx-terminal-host` are
private companions; the latter retains PTYs and monitors across sessions.

To build from source:

```sh
git clone https://github.com/Leeeon233/fx-rs.git
cd fx-rs
cargo build --release --locked --workspace
./target/release/fxrs acp --help
```

Resume a durable session or select a different workspace with:

```sh
fxrs tui --session <session-id>
fxrs tui --cwd /path/to/project
```

## ACP integration

Configure an ACP client to launch `fxrs` with `acp` as its first argument. An
optional model route can be selected explicitly:

```sh
fxrs acp --model codex/gpt-5.6-sol
```

## Authentication

The ACP `initialize` response advertises the `codex:chatgpt` authentication
method. An ACP client can invoke `authenticate` to open the browser-based
ChatGPT OAuth flow. fxrs stores credentials it owns under
`~/.fx/credentials`, with private permissions, process locks, and atomic
replacement.

If no fxrs-owned credential exists, the Codex Provider can read a valid
`~/.codex/auth.json` created by `codex login`. That ambient credential is never
refreshed, rewritten, or deleted by fxrs.

In the TUI, run `/login` to invoke the advertised authentication method; when
multiple providers advertise methods, fxrs opens a provider picker.
Authentication remains provider-owned, and the frontend contains no
Codex-specific credential logic.

## Architecture

Codex is the first concrete Provider. The registry supports multiple providers
at once and routes models as `provider/model`, so adding OpenAI API-key,
Anthropic, or other adapters does not change the agent loop, ACP projection,
credential store, or child-agent model selection.

ACP-reachable capabilities include durable event-log sessions, streaming and
cancellation, permission review, filesystem tools, PTY sessions and monitors,
web search/fetch, skills, memory, stored tool results, MCP stdio/Streamable
HTTP tools, scoped project instructions, and durable subagents.

See the [architecture](https://github.com/Leeeon233/fx-rs/blob/main/docs/architecture.md),
[migration map](https://github.com/Leeeon233/fx-rs/blob/main/docs/migration.md),
[release procedure](https://github.com/Leeeon233/fx-rs/blob/main/docs/releasing.md),
and frozen Zig
[source inventory](https://github.com/Leeeon233/fx-rs/blob/main/docs/source-inventory.md).

## Development

```sh
cargo fmt --all --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --locked
```

See the [contribution guidelines](https://github.com/Leeeon233/fx-rs/blob/main/CONTRIBUTING.md)
and [security policy](https://github.com/Leeeon233/fx-rs/blob/main/SECURITY.md).

## License

Licensed under the [Apache License 2.0](LICENSE).