https://github.com/verseles/codewalk
A native (really fast!!) cross-platform client for OpenCode
https://github.com/verseles/codewalk
ai anthropic claude-code codex crush dart desktop flutter gemini gemini-cli kilo-code mobile openai opencode
Last synced: 9 days ago
JSON representation
A native (really fast!!) cross-platform client for OpenCode
- Host: GitHub
- URL: https://github.com/verseles/codewalk
- Owner: verseles
- License: other
- Created: 2020-06-02T03:19:32.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-05-24T03:19:55.000Z (23 days ago)
- Last Synced: 2026-05-24T05:14:03.320Z (23 days ago)
- Topics: ai, anthropic, claude-code, codex, crush, dart, desktop, flutter, gemini, gemini-cli, kilo-code, mobile, openai, opencode
- Language: Dart
- Homepage:
- Size: 48.7 MB
- Stars: 155
- Watchers: 5
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
- Notice: NOTICE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# CodeWalk
> ⚠️ **Visual glitches known**: The conversation screen has some visual glitches we're working to fix. If you notice layout issues, flickering, or rendering artifacts, they are being actively addressed.
https://github.com/user-attachments/assets/032f64e2-e8ee-4024-b49a-ca95a774653f
A native (really fast!!) cross-platform client for [OpenCode](https://github.com/anomalyco/opencode) server mode. Built with Flutter, it provides a conversational interface for session-based AI coding interactions over HTTP APIs and streaming events.
## Unique Features
- 🌐 Fully translated into 14 languages: English, Português (Brasil), Español, Deutsch, Français, Italiano, Русский, 中文, 日本語, 한국어, हिन्दी, বাংলা, العربية, اردو
- 🎙 Speech-to-text on every platform, including Linux
- 🔊 Text-to-speech read-aloud for assistant messages
- 📊 Real-time quota monitoring for OpenCode Go, Codex, Gemini, and GitHub Copilot
- 📈 Inline Mermaid diagram rendering from fenced markdown blocks
- 💬 Canned answers for faster replies
- ↩️ Easier undo and redo
- 🧙 OpenCode setup wizard
- 🔢 LaTeX math rendering — typeset inline and block equations via pure-Dart KaTeX port
- 📤 Share messages as images — export any chat message as a themed PNG with native share
- 🔐 Cloudflare Access OAuth — PKCE-based auth for servers behind Cloudflare Access
- 📋 Session export as Markdown/JSON — full conversation export with paginated loading
- 🖥 Server-hosted PTY terminal — embedded terminal running on the OpenCode host
- ↩️ Inline revert to any prior turn — undo with draft restoration via official revert endpoint
## Highlights
- Realtime AI chat with streaming responses (SSE) and robust turn reconciliation
- Queued `Send now` handoff without false abort error noise or duplicate chat bubbles
- Instant session reopen with cached grouped history, direct bottom landing, and background delta-style revalidation
- Load older message history by scrolling to the top of chat
- Project-centric sidebar with conversations grouped by open projects
- Context-scoped conversation pinning to keep priority sessions at top
- Canned answers with global/project scope
- Project context support for both Git repositories and non-Git folders
- Per-project New Chat draft isolation with lazy session bootstrap
- Multi-server profile management (health checks, default/active switching, auth)
- Install and Run OpenCode Server directly from Settings
- Model/provider selection with variants, favorites, and reasoning controls
- In-app update flow with auto-check, startup notification, and direct install
- Physical-keyboard productivity shortcuts, including Alt+Tab-style session cycling
- Mobile external-keyboard send keeps composer focus for rapid follow-up input
- Interactive server permission/question prompts with attention badges
- Responsive Material 3 experience across Linux, Windows, macOS, Web, and Android
- 14-language support with instant language switching, system-default detection, and RTL layout for Arabic and Urdu
- Text-to-speech read-aloud for assistant responses with adjustable speed and pitch
- Mermaid diagram rendering from fenced code blocks with copy-source fallback
- Density-aware UI with 5 spacing tiers (compact → spacious) across chrome and composer
- Smart session state restore — re-selects last agent/model/variant from message metadata
- Reactive notification dismissal — auto-clears on SSE events, no stale alerts
- Rich diff review surface with syntax highlighting, line gutters, and lazy hunk loading
- Cloudflare Access OAuth with PKCE for secure enterprise reverse-proxy auth
- Server-hosted PTY terminal streamed to client for in-app command-line access
## Install in One Command
Install using the `install.cat` pattern:
- Linux & macOS
```bash
curl -fsSL install.cat/verseles/codewalk | sh
```
- Windows (PowerShell)
```powershell
irm install.cat/verseles/codewalk | iex
```
Run the same command again any time to update/reinstall to the latest GitHub release.
Installers automatically pick the right release for your platform.
- Android
Open this in your Android browser to download the APK:
[install.cat/verseles/codewalk](https://install.cat/verseles/codewalk)
### Uninstall
- Linux & macOS
```bash
curl -fsSL https://raw.githubusercontent.com/verseles/codewalk/main/uninstall.sh | sh
```
- Windows (PowerShell)
```powershell
irm https://raw.githubusercontent.com/verseles/codewalk/main/uninstall.ps1 | iex
```
## Getting Started
### Prerequisites
- Flutter SDK (>=3.8.1)
- Dart SDK
- An OpenCode-compatible server instance
- Platform toolchain for your target:
- Linux desktop: `clang`, `cmake`, `ninja`, `pkg-config`
- Windows desktop: build from a Windows host
- macOS desktop: build from a macOS host
### Setup
1. Install dependencies:
```bash
flutter pub get
```
2. Run the app (examples):
```bash
flutter run -d linux
flutter run -d chrome
flutter run -d android
```
3. Build artifacts (examples):
```bash
flutter build linux
flutter build web
```
### Make Targets
```bash
make check # deps + codegen + analyze + test
make check-fast # deps + codegen + analyze + test-fast
make test-fast # excludes slow/integration tags
make android # build arm64 APK
make precommit # check + android
```
### Server Configuration
1. Launch the app and open **Settings** from the sidebar
2. Tap **Add Server** and run the Quick setup command in your terminal
3. Keep the default `Server URL` (`http://127.0.0.1:4096`) or set your server URL
4. Configure Basic Auth only if your server requires it
5. Save and switch active/default profiles as needed
### OpenCode Project Agent
When you run OpenCode from this repository, the repo ships a project agent at `.opencode/agents/opencodeNews.md`:
- `@opencodeNews` reviews the latest OpenCode release for CodeWalk impact
- `@opencodeNews review vX.Y.Z` or `@opencodeNews check https://github.com/anomalyco/opencode/releases/tag/...` reviews a specific release target mentioned in the same prompt
The agent returns a release summary, impact/risk by area, proposed adjustments, and an execution plan only when CodeWalk work is needed.
## Architecture
The project follows Clean Architecture with three layers: Domain, Data, and Presentation. Dependency injection via `get_it`, HTTP via `dio`, state management via `provider`.
For the ADR-023 compatibility baseline and current OpenCode contract inventory, see [CONTRACT_MATRIX.md](CONTRACT_MATRIX.md).
For full technical details, see [CODEBASE.md](CODEBASE.md).
## Tech Stack
- **Framework:** Flutter
- **Language:** Dart
- **State Management:** Provider
- **HTTP Client:** Dio
- **Local Storage:** SharedPreferences
- **Dependency Injection:** GetIt
- **Design System:** Material Design 3
## License
This project is dual-licensed:
- **Open Source:** [GNU Affero General Public License v3.0 (AGPLv3)](LICENSE) -- free for everyone.
- **Commercial:** A [separate commercial license](LICENSE-COMMERCIAL.md) is available for organizations with annual revenue exceeding USD 1M that wish to use the software without AGPLv3 obligations.
## Origin and Acknowledgment
CodeWalk is a fork of [OpenMode](https://github.com/easychen/openMode), originally created by [easychen](https://github.com/easychen). The original project is licensed under MIT.
Substantial modifications have been made since the fork, including licensing changes, code restructuring, rebranding, full English standardization, and documentation rewrites. All modifications are licensed under AGPLv3 (or the commercial license, where applicable).
See [NOTICE](NOTICE) for full attribution details.