Skip to content

Commit dfd261c

Browse files
committed
docs: simplify readme
1 parent 1f07648 commit dfd261c

1 file changed

Lines changed: 62 additions & 81 deletions

File tree

README.md

Lines changed: 62 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<p align="center">
1111
<strong>I came, I saw, I conquered. / 我来,我见,我征服。</strong><br>
12-
<sub>Campaign command table for Claude Code, Codex, and terminal sessions</sub><br>
12+
<sub>Desktop command table for Claude Code, Codex, terminal sessions, and local AI coding history</sub><br>
1313
<sub>macOS • Windows • Linux</sub>
1414
</p>
1515

@@ -24,97 +24,71 @@
2424

2525
<p align="center">
2626
<a href="https://code.lovstudio.ai/">Website</a> •
27-
<a href="#release-highlights">Updates</a> •
27+
<a href="#overview">Overview</a> •
2828
<a href="#features">Features</a> •
29-
<a href="#oh-my-lovcode">oh-my-lovcode</a> •
3029
<a href="#installation">Installation</a> •
3130
<a href="#usage">Usage</a> •
31+
<a href="#development">Development</a> •
3232
<a href="#tech-stack">Tech Stack</a> •
33-
<a href="#license">License</a>
33+
<a href="#release-notes">Release Notes</a>
3434
</p>
3535

3636
---
3737

38-
## Release Highlights
38+
## Overview
3939

40-
### v0.37.0 — Runtime Settings, Page Windows, and Backend Modules
40+
Lovcode is an open-source desktop app for developers who work with multiple AI coding tools. It brings Claude Code, Codex, terminal sessions, local chat history, linked files, runtime configuration, commands, MCP servers, skills, hooks, and MaaS providers into one local command table.
4141

42-
Lovcode now has dedicated agent CLI runtime configuration for Claude Code and Codex, including install/version status surfaces and reusable runtime settings under Configuration. Page windows and session navigation gain duplicate-window and resume helpers, plus richer project path menu actions across the workbench. Feedback operations now include an admin dialog, while the Tauri backend has been split into focused app command modules for maintainability.
42+
The goal is simple: arrive at the right project, see the full context, and resume or hand off work without digging through scattered terminals and exports.
4343

44-
### v0.36.0 — Localized Workbench, Session Handoff, and Lab
45-
46-
Lovcode now localizes the main workspace, settings, marketplace, environment, update, and feedback surfaces in English and Chinese, with a language preference in app settings. The agent workbench gains richer conversation management: pinned and archived conversation state, chat/PTY display mode switching, session information dialogs, related-file and trace-context copy actions, and cross-agent handoff prompts for moving context between Claude Code and Codex. This release also adds the Lab and Wish Room entry points, improves Lovstudio-authenticated feedback tickets with tags and account tracking, and makes release history refresh more resilient through GitHub API caching and Atom fallback.
44+
![Gallery](docs/assets/gallery.png)
4745

48-
### v0.35.0 — General Chat, Version Manager, and Codex MaaS
46+
## Workflow
4947

50-
The agent workbench can now start general chat sessions without first selecting a project, while the composer exposes recent project paths and a clearer CLI picker for faster session setup. Lovcode also adds a status-bar version manager with release history, manual update checks, auto-update controls, and direct release links. MaaS providers can now be activated separately for Claude Code and Codex, including Codex `config.toml` provider updates for API-key providers.
48+
| Step | Lovcode keeps close |
49+
|------|---------------------|
50+
| **I came** | Project paths, agent runtimes, setup scripts, and session launch controls |
51+
| **I saw** | Searchable histories, tool calls, linked files, usage details, and structured traces |
52+
| **I conquered** | Resume actions, cross-agent handoff prompts, archived context, and release-ready records |
53+
| **我来** | 项目目录、运行时、启动脚本和 Agent 入口 |
54+
| **我见** | 可搜索历史、工具调用、关联文件和结构化上下文 |
55+
| **我征服** | 可续接会话、跨 Agent 交接、归档记录和交付线索 |
5156

52-
### v0.34.0 — Agent Workbench and Codex History
57+
## Features
5358

54-
Lovcode now has an agent workbench for launching Claude Code, Codex, and terminal sessions from a selected project, with persistent workspace state, project/session environment scripts, and hook-based activity tracking. Codex rollout sessions are indexed alongside Claude history with a dedicated Codex filter, usage extraction, resume support, and live updates from `~/.codex/sessions`. File and document previews now support multi-tab file previews, ZIP archive browsing, unsupported binary/document fallbacks, Markdown frontmatter, and remote/local image rendering.
59+
### Workbench
5560

56-
### v0.33.0 — Skills Table and Smart Path Routing
61+
- Launch Claude Code, Codex, terminal, or general chat sessions from a selected project.
62+
- Keep project/session setup, cleanup, and custom runtime scripts available in the embedded terminal dock.
63+
- Track pinned, archived, unread, review, runtime, and display-mode state across sessions.
64+
- Duplicate windows, resume sessions, and copy project path actions from the workbench.
5765

58-
Skills management now uses a dense sortable table with vendor/source filters, install metadata, token estimates, and marketplace previews. Markdown content across marketplace and file previews shares the same renderer with GFM tables and smart local-path links, including candidate-prefix routing for agent output paths. File previews now use a compact Finder-style breadcrumb for faster navigation, and structured tool results can preview generated images inline.
66+
### History and Search
5967

60-
### v0.32.0 — Inline File Preview
68+
- Browse Claude Code, Codex, app-code, app-web, and app-cowork histories from one viewer.
69+
- Search full text, session IDs, metadata, and details with Chinese-aware indexing.
70+
- Index active and archived Codex session files, including dotted tokens such as domains, package names, and asset names.
71+
- Inspect tool calls, thinking blocks, grouped results, generated images, and token/cost context.
6172

62-
Local paths in prompts and chat messages now open inside Lovcode with a resizable preview pane. File references with `:line:column` jump directly to the target location, global search has scoped modes for text, IDs, and metadata, and document sidebars can be resized and restored.
73+
### Files and Context
6374

64-
| Version | Highlights |
65-
|---------|------------|
66-
| **0.37.0** | Agent CLI runtime configuration for Claude Code and Codex with install/version status cards; duplicate-window and resume helpers for page/session workflows; richer project path menu actions; feedback administration dialog; Tauri backend split into focused app command modules |
67-
| **0.36.0** | English/Chinese localization reaches the workspace, settings, marketplace, environment, update, and feedback flows; the workbench adds pinned/archived conversations, chat/PTY display modes, session info dialogs, related-file and trace-context copying, and Claude Code/Codex handoff prompts; new Lab and Wish Room routes provide an experimental planning surface; Lovstudio feedback now uses authenticated ticket submission with tags; release history refresh uses GitHub API cache plus Atom fallback |
68-
| **0.35.0** | General chat sessions can start without a selected project; the agent composer now offers recent project paths and a compact CLI picker; the status bar opens a Lovcode version manager with release history, manual update checks, auto-update controls, and release links; MaaS provider activation can target Claude Code and Codex separately, writing Codex provider settings into `config.toml` |
69-
| **0.34.0** | Agent Workbench launches Claude Code, Codex, and terminal sessions with persistent state; project/session environment scripts can be saved and run from Lovcode; Claude and Codex hooks track activity; Codex rollout sessions are indexed with filtering, usage extraction, resume support, and live updates; file previews now support tabs, ZIP browsing, unsupported-format fallbacks, and richer Markdown/image rendering |
70-
| **0.33.0** | Skills management table with vendor/source filtering, ranking, install metadata, token estimates, and marketplace previews; shared MarkdownRenderer table/path support across marketplace and file previews; smart path routing offers candidate prefix paths for agent output files; FileViewer path navigation uses a compact Finder-style breadcrumb; tool-result images can open in the preview pane |
71-
| **0.32.0** | Inline file preview for local path links with line/column reveal, directory browsing, and resizable preview pane; prompt path detection handles `@src/file.tsx:line:column(selector)` style references; global search gains All / Full text / Session ID / Details modes; document reader sidebars are now resizable and persisted |
72-
| **0.31.0** | Architecture refactor: removed Workspace dashboard (PanelGrid, FeatureTabs, KanbanBoard, GitHistory, LogoManager, ProjectDashboard) in favor of page-centric routing; `/chat/*``/history/*`; `/knowledge/reference` (static) → `/knowledge/source/[id]` (dynamic) with `[...docPath]` sub-routes; new `useStreamedSessions` hook for streamed session list rendering; splash now waits for `/history` `ProjectList` `app:ready` signal before dismissing; LLM provider settings page removed |
73-
| **0.30.1** | Patch: silence dev-mode `[TAURI] Couldn't find callback id` warnings — defer `get_network_info` to next macrotask, persist `NETWORK_INFO_CACHE` to `~/.lovstudio/lovcode/cache/network.json` so dev restarts keep the cache; annual-report-2025 no longer recorded as `lastPath` resume target |
74-
| **0.30.0** | Chat session list & global search overhaul: `readLiteMetadata`-aligned head/tail 64KB title scanner with `title_source` field surfaced as a multi-purpose dot in the list (custom black / AI terracotta / summary blue / slug green / prompt grey / none faded); fix consecutive same-role user messages being merged; built-in slash commands (`/clear`, etc.) now format correctly even with reordered `<command-name>` tags; new `GlobalChatSearch` overlay + `search-overlay` route for cross-session full-text search; double-click a user prompt opens it in a standalone `prompt-detail` webview; Recent header toolbar always visible (`SlidersHorizontal` icon); session metadata extraction switched from full-JSON parse to byte-level scan, dramatically faster on tens-of-MB sessions |
75-
| **0.29.0** | MaaS registry: new `Vendor` entity separates model vendors (anthropic/openai) from access platforms (zenmux/modelgate); tokens now stored inline (migrated from `authEnvKey`) with a verified-fingerprint stamp; models gain description / icon / modalities / context-window metadata; `fetchCommand` for remote model-list pull; Settings/MaaS view rewritten; inline provider/model picker in the chat input footer with a 5-slot MRU persisted across sessions |
76-
| **0.28.0** | Session detail footer shows provider · model · peak context-window occupancy (input + cache aggregate); `messages` count switched to `rounds` (user prompts only); markdown `[text](path)` links resolve through smart PathLink (existence-checked + context menu); router restores last page on reload instead of forcing Dashboard |
77-
| **0.27.0** | Data source split into `cli` / `app-code` / `app-web` / `app-cowork` with two-level tabs; bottom inline input to continue a session; merge consecutive same-role messages; GFM tables + code-block syntax highlighting in chat |
78-
| **0.26.0** | Sidebar refactor — Pinned / Recent / Import groups + Algolia-style ⌘K search; live sync of claude.ai web chats (Cookies + Keychain decrypt → API pull); Pinned tri-state toggle mirrored to Claude desktop `starredIds` |
79-
| **0.25.0** | MaaS provider registry (`/settings/maas`) with 4 Tauri commands; new `/events` page; LLM provider presets extracted; standalone Home consolidated into Workspace |
80-
| **0.24.16** | Import claude.ai web exports (.zip/dir), data source tabs (All / Code / Web) |
81-
| **0.24.15** | Structured content blocks — view tool calls, thinking, tool results |
82-
| **0.24.14** | Full-text search with jieba Chinese tokenization |
83-
| **0.24.12** | Two-column master-detail layout with grouped/flat toggle |
84-
| **0.24.11** | In-app auto-updater |
85-
| **0.24.7** | Session usage tracking with token counts and cost estimation |
86-
| **0.24.0** | File-system routing architecture, settings split into sub-pages |
75+
- Open local paths from prompts, markdown links, and agent output directly inside Lovcode.
76+
- Preview UTF-8 text, Markdown, images, directories, ZIP archives, and unsupported binary fallbacks.
77+
- Jump to line/column references and route unresolved agent paths through candidate prefixes.
78+
- Copy session information, related files, trace context, and handoff prompts for Claude Code or Codex.
8779

88-
[Full Changelog](CHANGELOG.md)
80+
### Configuration
8981

90-
![Gallery](docs/assets/gallery.png)
82+
- Manage commands, MCP servers, skills, hooks, sub-agents, output styles, runtime environments, and MaaS providers.
83+
- Configure Claude Code and Codex runtimes, inspect install/version status, and keep runtime preferences local.
84+
- Activate MaaS providers separately for Claude Code and Codex with vendor/model metadata and token verification.
85+
- Browse marketplace templates and installed skills with sorting, filtering, previews, and token estimates.
9186

92-
## Features
87+
### App Surface
9388

94-
- **Dashboard** — Start from a cross-module overview of history, active agents, reusable commands, distilled knowledge, and recent project activity
95-
- **Lab & Wish Room** — Track wishes, link them to projects or sessions, and keep experimental planning flows under the Lab surface
96-
- **Localized Interface** — Switch between system language, English, and Chinese across the main workspace, settings, marketplace, feedback, updates, and runtime environment screens
97-
- **Agent Workbench** — Launch Claude Code, Codex, or a terminal in a selected project or general chat workspace; track pinned/archived sessions, unread/review states, runtime activity, and chat/PTY display mode
98-
- **Agent Runtime Settings** — Configure Claude Code and Codex CLI runtimes, inspect install/version status, and manage runtime preferences from Configuration
99-
- **Session Handoff Tools** — Copy session info, related file paths, trace context, and cross-agent handoff prompts for moving work between Claude Code and Codex
100-
- **Environment Scripts** — Save project/session setup, cleanup, and custom runtime actions, then run them in an embedded terminal dock
101-
- **Chat History Viewer** — Browse and search Claude and Codex conversation history across all projects with scoped full-text, session ID, and metadata search modes
102-
- **Granular Data Sources** — Switch between `cli` (Claude Code), `codex`, `app-code`, `app-web`, and `app-cowork` with source filters
103-
- **Live claude.ai Sync** — Pull web conversations directly via decrypted cookies (no manual export needed); also supports `.zip` / directory import
104-
- **Continue From the Bottom** — Reply to a session inline without leaving the detail view
105-
- **Rich Markdown Rendering** — GFM tables and syntax-highlighted code blocks (Warm Academic theme) inside chat messages
106-
- **Smart Path Links** — Bare paths, prompt mentions, and markdown `[text](path)` links are existence-checked against the relevant `cwd`; unresolved agent-output paths surface candidate prefix routes and existing files open in a tabbed Lovcode preview pane
107-
- **File and Document Preview** — Preview UTF-8 text, Markdown, images, directories, and ZIP archives inline; unsupported binary/document formats fall back to clear open/reveal actions
108-
- **Live Context-Window Readout** — Session detail footer shows the active model, provider, and peak context-window occupancy (input + cache_read + cache_creation) per round
109-
- **Structured Content Blocks** — Tool calls, thinking, grouped tool results, and generated images render as first-class blocks with preview support
110-
- **Sidebar with Pinned / Recent / Import** — Tri-state Pinned toggle mirrored to Claude desktop `starredIds`; Algolia-style ⌘K search
111-
- **MaaS Registry** — Manage custom Model-as-a-Service providers with vendor/model hierarchy, inline tokens, Verify fingerprinting, remote model-list pull, and separate Claude Code / Codex activation scopes (`/settings/maas`)
112-
- **Inline Model Picker** — Switch active provider · vendor · model from the chat input footer; MRU remembers your last 5 picks across sessions
113-
- **Commands / MCP / Skills / Hooks / Sub-Agents / Output Styles** — Full configuration surface for the Claude Code ecosystem
114-
- **Skills Manager** — Sort, rank, filter, preview, and inspect installed skills with vendor/source metadata, install timestamps, and token estimates
115-
- **Marketplace** — Browse and install community templates with shared Markdown table rendering and smart local-path links
116-
- **Lovstudio Feedback Tickets** — Submit authenticated feedback tickets with tags, copy ticket IDs, open Lovstudio account tracking, and review tickets from an admin dialog
117-
- **Customizable Statusbar** — Personalize your statusbar display with scripts and open Lovcode version management from the app version indicator
89+
- Localized interface for English, Chinese, and system language.
90+
- In-app update checks, release history, auto-update controls, and direct release links.
91+
- Authenticated Lovstudio feedback tickets with tags, ticket IDs, and admin review tooling.
11892

11993
## oh-my-lovcode
12094

@@ -128,11 +102,21 @@ Share and discover statusbar themes, keybindings, and more at [oh-my-lovcode](ht
128102

129103
## Installation
130104

131-
### From Release
132-
133105
Download the latest release for your platform from [Releases](https://github.com/lovstudio/lovcode/releases).
134106

135-
### From Source
107+
Lovcode publishes desktop builds for macOS, Windows, and Linux when release workflows complete.
108+
109+
## Usage
110+
111+
1. Launch Lovcode.
112+
2. Open **Workbench** and choose a project, runtime, setup script, and agent channel.
113+
3. Start Claude Code, Codex, terminal, or general chat work from the selected context.
114+
4. Use **History** and global search to find previous sessions across Claude Code, Codex, and app sources.
115+
5. Open a session to inspect tool calls, thinking, linked files, generated images, and usage details.
116+
6. Continue from the session footer, resume in a new agent, or copy handoff context.
117+
7. Manage commands, MCP servers, skills, hooks, output styles, runtime settings, and MaaS providers under **Configuration**.
118+
119+
## Development
136120

137121
```bash
138122
# Clone the repository (with submodules)
@@ -152,16 +136,6 @@ pnpm dev:app:no-watch
152136
pnpm tauri build
153137
```
154138

155-
## Usage
156-
157-
1. Launch Lovcode
158-
2. Start on **Dashboard** for a cross-module overview, or open **Workbench** to launch a Claude Code, Codex, terminal, or general chat session
159-
3. Use **History** to browse sessions; source filters include `cli`, `codex`, `app-code`, `app-web`, and `app-cowork`
160-
4. Open a session: tool calls, thinking, GFM tables, code blocks, and linked file previews render inline; reply at the bottom to continue
161-
5. Live-sync claude.ai web chats from your logged-in browser, or import a `.zip` / folder export
162-
6. Manage commands, MCP servers, skills, hooks, sub-agents, output styles, runtime environments, and MaaS providers under **Configuration**; MaaS activation can target Claude Code and Codex independently
163-
7. Visit **Marketplace** to discover community templates
164-
165139
## Tech Stack
166140

167141
| Layer | Technology |
@@ -172,6 +146,13 @@ pnpm tauri build
172146
| State | Jotai |
173147
| Search | Tantivy + jieba (full-text, Chinese-aware) |
174148

149+
## Release Notes
150+
151+
The README stays focused on the current product surface. Version-by-version details live in:
152+
153+
- [CHANGELOG.md](CHANGELOG.md)
154+
- [GitHub Releases](https://github.com/lovstudio/lovcode/releases)
155+
175156
## Star History
176157

177158
[![Star History Chart](https://api.star-history.com/svg?repos=lovstudio/lovcode&type=Date)](https://star-history.com/#lovstudio/lovcode&Date)

0 commit comments

Comments
 (0)