Update README with full feature coverage
Add Ctx Manager panel, setup wizard, import/export, session colors, ctx CLI flags (--shared, append, export), and FTS/WAL details. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
31fed163d0
commit
5815943861
1 changed files with 37 additions and 16 deletions
53
README.md
53
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# BTerminal
|
||||
|
||||
Terminal with session panel (MobaXterm-style), built with GTK 3 + VTE. Catppuccin Mocha theme.
|
||||
GTK 3 terminal with SSH & Claude Code session management, macros, and a cross-session context database. Catppuccin Mocha theme.
|
||||
|
||||
> **v2 complete, v3 all phases complete.** v2: Multi-session Claude agent dashboard using Tauri 2.x + Svelte 5. v3: Multi-project mission control dashboard (All Phases 1-10 complete + sidebar redesign) -- project groups with per-project Claude sessions, session continuity (persist/restore agent messages), team agents panel, terminal tabs, **VSCode-style left sidebar** (vertical icon rail + expandable drawer panel + always-visible workspace), command palette with group switching. Features: **project groups** (up to 5 projects per group, horizontal layout, adaptive viewport count), **per-project Claude sessions** with session continuity, **team agents panel** (compact subagent cards), **terminal tabs** (shell/SSH/agent per project), agent panes with structured output, tree visualization with subtree cost and session resume, **subagent/agent-teams support**, **multi-machine support** (bterminal-relay WebSocket server + RemoteManager), **Claude profile/account switching** (switcher-claude integration), **skill discovery and autocomplete** (type `/` in agent prompt), SSH session management, ctx context database viewer, SQLite session persistence with layout restore, live markdown file viewer with Shiki syntax highlighting, 17 themes in 3 groups (4 Catppuccin + 7 Editor + 6 Deep Dark: Tokyo Night, Gruvbox Dark, Ayu Dark, Poimandres, Vesper, Midnight), **global font controls** (separate UI font [sans-serif] + terminal font [monospace] with live preview), .deb + AppImage packaging, GitHub Actions CI, 138 vitest + 36 cargo tests. Branch `v2-mission-control`. See [docs/v3-task_plan.md](docs/v3-task_plan.md) for v3 architecture.
|
||||
|
||||
|
|
@ -8,14 +8,21 @@ Terminal with session panel (MobaXterm-style), built with GTK 3 + VTE. Catppucci
|
|||
|
||||
## Features
|
||||
|
||||
- **SSH sessions** — saved configs (host, port, user, key, folder, color), CRUD with side panel
|
||||
- **Claude Code sessions** — saved Claude Code configs with sudo, resume, skip-permissions and initial prompt
|
||||
- **SSH macros** — multi-step macros (text, key, delay) assigned to sessions, run from sidebar
|
||||
- **Tabs** — multiple terminals in tabs, Ctrl+T new, Ctrl+Shift+W close, Ctrl+PageUp/Down switch
|
||||
- **Sudo askpass** — Claude Code with sudo: password entered once, temporary askpass helper, auto-cleanup
|
||||
- **Folder grouping** — SSH and Claude Code sessions can be grouped in folders on the sidebar
|
||||
- **ctx — Context manager** — SQLite-based cross-session context database for Claude Code projects
|
||||
- **Catppuccin Mocha** — full theme: terminal, sidebar, tabs, session colors
|
||||
- **SSH sessions** — saved configs (host, port, user, key, folder, color), one-click connect from sidebar
|
||||
- **Claude Code sessions** — saved configs with sudo askpass, resume, skip-permissions and initial prompt
|
||||
- **SSH macros** — multi-step automation (text, key press, delay) bound to sessions, runnable from sidebar
|
||||
- **Tabs** — multiple terminals in tabs with reordering, auto-close and shell respawn
|
||||
- **Folder grouping** — organize both SSH and Claude Code sessions in collapsible sidebar folders
|
||||
- **Session colors** — 10 Catppuccin accent colors for quick visual identification
|
||||
- **Sudo askpass** — temporary helper for Claude Code sudo mode: password entered once, auto-cleanup on exit
|
||||
- **Catppuccin Mocha** — full theme across terminal, sidebar, tabs, dialogs and scrollbars
|
||||
|
||||
### Context Manager
|
||||
|
||||
- **ctx CLI** — SQLite-based tool for persistent context across Claude Code sessions
|
||||
- **Ctx Manager panel** — sidebar tab for browsing, editing and managing all project contexts
|
||||
- **Ctx Setup Wizard** — step-by-step project setup with auto-detection from README and CLAUDE.md generation
|
||||
- **Import / Export** — selective import and export of projects, entries, summaries and shared context via JSON with checkbox tree UI
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -30,7 +37,7 @@ The installer will:
|
|||
2. Copy files to `~/.local/share/bterminal/`
|
||||
3. Create symlinks: `bterminal` and `ctx` in `~/.local/bin/`
|
||||
4. Initialize context database at `~/.claude-context/context.db`
|
||||
5. Add desktop entry to application menu
|
||||
5. Add desktop entry and icon to application menu
|
||||
|
||||
### v2 Installation (Tauri — build from source)
|
||||
|
||||
|
|
@ -60,23 +67,37 @@ bterminal
|
|||
|
||||
## Context Manager (ctx)
|
||||
|
||||
`ctx` is a SQLite-based tool for managing persistent context across Claude Code sessions.
|
||||
`ctx` is a SQLite-based tool for managing persistent context across Claude Code sessions. It uses FTS5 full-text search and WAL journal mode.
|
||||
|
||||
```bash
|
||||
ctx init myproject "Project description" /path/to/project
|
||||
ctx get myproject # Load full context (shared + project)
|
||||
ctx get myproject # Load project context
|
||||
ctx get myproject --shared # Include shared context
|
||||
ctx set myproject key "value" # Save a context entry
|
||||
ctx shared set preferences "value" # Save shared context (available in all projects)
|
||||
ctx append myproject key "more" # Append to existing entry
|
||||
ctx shared set preferences "value" # Save shared context (all projects)
|
||||
ctx summary myproject "What was done" # Save session summary
|
||||
ctx search "query" # Full-text search across everything
|
||||
ctx list # List all projects
|
||||
ctx history myproject # Show session history
|
||||
ctx export # Export all data as JSON
|
||||
ctx delete myproject [key] # Delete project or entry
|
||||
ctx --help # All commands
|
||||
```
|
||||
|
||||
### Ctx Manager Panel
|
||||
|
||||
The sidebar **Ctx** tab provides a GUI for the context database:
|
||||
|
||||
- Browse all projects and their entries in a tree view
|
||||
- View entry values and project details in the detail pane
|
||||
- Add, edit and delete projects and entries
|
||||
- **Export** — select specific projects, entries, summaries and shared context to save as JSON
|
||||
- **Import** — load a JSON file, preview contents with checkboxes, optionally overwrite existing entries
|
||||
|
||||
### Integration with Claude Code
|
||||
|
||||
Add a `CLAUDE.md` to your project root:
|
||||
Add a `CLAUDE.md` to your project root (the Ctx Setup Wizard can generate this automatically):
|
||||
|
||||
```markdown
|
||||
On session start, load context:
|
||||
|
|
@ -94,8 +115,8 @@ Config files in `~/.config/bterminal/`:
|
|||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `sessions.json` | Saved SSH sessions + macros |
|
||||
| `claude_sessions.json` | Saved Claude Code configs |
|
||||
| `sessions.json` | SSH sessions and macros |
|
||||
| `claude_sessions.json` | Claude Code session configs |
|
||||
|
||||
Context database: `~/.claude-context/context.db`
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue