You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> A local-first AI coding agent that helps you understand code, edit projects, call tools, and connect your workflow across terminal, desktop, and automation.
5
+
> A local-first AI coding agent that helps you understand code, edit projects, call tools, and connect your development workflow across terminal, desktop, and automation.
6
6
7
7
<palign="center">
8
8
<ahref="https://go.dev/">
@@ -35,9 +35,9 @@
35
35
36
36
## What Is NeoCode?
37
37
38
-
NeoCode is an AI coding agent running in your local development environment.
38
+
NeoCode is an AI coding agent that runs in your local development environment.
39
39
40
-
It can read your workspace, understand code, call tools, run commands, manage sessions, and expose a unified local Gateway interface (JSON-RPC / SSE / WebSocket) for terminal, desktop, or third-party clients.
40
+
It can read your workspace, understand code, call tools, execute commands, manage sessions, and expose a unified local Gateway interface via JSON-RPC / SSE / WebSocket for terminal, desktop, or third-party clients.
41
41
42
42
Core loop:
43
43
@@ -47,25 +47,30 @@ Core loop:
47
47
48
48
## Features
49
49
50
-
- Local-first execution with real project context.
51
-
- Terminal-native TUI experience.
52
-
- Built-in tools for file access, project inspection, and command execution.
Set environment variables for your provider, for example:
103
+
Set the environment variable for your selected provider, for example:
99
104
100
105
```bash
101
106
export OPENAI_API_KEY="your_key_here"
@@ -107,21 +112,41 @@ Windows PowerShell:
107
112
$env:OPENAI_API_KEY = "your_key_here"
108
113
```
109
114
110
-
Then start with your workspace:
115
+
Then start in your project directory:
111
116
112
117
```bash
113
118
neocode -w /path/to/your/project
114
119
```
115
120
116
-
To launch the browser-based Web UI:
121
+
If you want to use the browser-based Web UI, run:
117
122
118
123
```bash
119
124
neocode web
120
125
```
121
126
122
-
Tagged release builds already embed `web/dist` into the `neocode` binary, so the target machine does not need Node.js or npm. When running from source, missing `web/dist` still triggers the local frontend build path.
127
+
Tagged release builds already embed Web UI assets (`web/dist`) into the `neocode` binary, so running `neocode web` does not require Node.js or npm on the target machine. If you run from source with `go run ./cmd/neocode web`, NeoCode will still automatically try to build the frontend when `web/dist` is missing.
128
+
129
+
### 4. Quick Web / Feishu Entry
130
+
131
+
```bash
132
+
# Browser Web UI (default 127.0.0.1:8080)
133
+
neocode web
134
+
135
+
# Specify Web UI listen address (for local debugging)
136
+
neocode web --http-listen 127.0.0.1:8080 --skip-build
137
+
138
+
# Feishu SDK mode (recommended, no public ingress required)
> -`run`: requires the `prompt` parameter. Gateway returns `session_id` and triggers terminal handoff.
284
+
285
+
Session handoff startup:
286
+
287
+
```bash
288
+
go run ./cmd/neocode --session <session_id>
289
+
```
290
+
291
+
> When `--session` is provided, TUI first attempts context handoff using the `workdir` saved in session history. If that path is no longer valid locally, NeoCode keeps the current workspace and displays a warning.
292
+
>
293
+
> On Linux (and other non-Windows/macOS platforms), automatic terminal popup is not yet integrated. `wake.run` returns `not_supported`, and you can manually run `neocode --session <session_id>` for handoff.
294
+
>
295
+
> `daemon serve` does not provide `--token-file`, listens only on `127.0.0.1`, and limits Host allowlist to `neocode` / `localhost` / `127.0.0.1`.
296
+
>
297
+
> Linux autostart strategy: prefer `systemd --user`; fall back to `~/.config/autostart/neocode-daemon.desktop` when unavailable.
298
+
>
299
+
> If NeoCode was not installed via install script (for example, built from source or using a bare binary), run `neocode daemon install` manually once.
300
+
160
301
---
161
302
162
-
## Documentation
303
+
## Documentation Map (By Scenario)
304
+
305
+
Official docs site (English): [https://neocode-docs.pages.dev/en/](https://neocode-docs.pages.dev/en/)
0 commit comments