opencode-miniterm 1.0.1 → 1.0.2

package/README.md

@@ -2,4 +2,167 @@
 
 A small front-end terminal UI for [OpenCode](https://github.com/anomalyco/opencode).
 
-This project is not affiliated with OpenCode.
+> **Note:** This project is not affiliated with OpenCode.
+
+## Features
+
+- **Slash Commands** - Quick access to common operations
+- **File Auto-Completion** - Type `@` followed by file path for intelligent completions
+- **Real-Time Streaming** - See AI responses as they're being generated
+- **Logging Support** - Optional conversation logging for debugging
+- **Keyboard Navigation** - Readline support with history and editing
+
+## Installation
+
+### Prerequisites
+
+- [OpenCode](https://github.com/anomalyco/opencode) - OpenCode server
+- [Bun](https://bun.sh/) - Required runtime
+
+### Install from npm
+
+```bash
+npm install -g opencode-miniterm
+# or
+pnpm add -g opencode-miniterm
+```
+
+### Install from Source
+
+```bash
+git clone https://github.com/your-repo/opencode-miniterm.git
+cd opencode-miniterm
+bun install
+bun link
+```
+
+### Quick Start
+
+```bash
+ocmt
+```
+
+This will:
+
+1. Start the OpenCode server (if not already running)
+2. Create or resume a session for the current directory
+3. Present the interactive prompt
+
+## Configuration
+
+Configuration is stored in `~/.config/opencode-miniterm/opencode-miniterm.json`:
+
+```json
+{
+	"providerID": "opencode",
+	"modelID": "big-pickle",
+	"agentID": "build",
+	"sessionIDs": {
+		"/path/to/project1": "session-id-1",
+		"/path/to/project2": "session-id-2"
+	},
+	"loggingEnabled": false
+}
+```
+
+### Environment Variables
+
+- `OPENCODE_SERVER_USERNAME` - Server username (default: "opencode")
+- `OPENCODE_SERVER_PASSWORD` - Server password (required if server has auth)
+- `OPENCODE_MT_CONFIG_CONTENT` - Override config as JSON string
+
+## Usage
+
+### Basic Interaction
+
+Simply type your question or request at the prompt and press Enter:
+
+```
+> Help me fix the bug in auth.ts
+```
+
+### Slash Commands
+
+| Command            | Description                                 |
+| ------------------ | ------------------------------------------- |
+| `/help`            | Show available commands                     |
+| `/init`            | Analyze project and create/update AGENTS.md |
+| `/new`             | Create a new session                        |
+| `/sessions`        | List and switch sessions                    |
+| `/diff`            | Show file additions and deletions           |
+| `/undo`            | Undo last assistant request                 |
+| `/details`         | Show detailed info for the previous request |
+| `/page`            | Page through the detailed info              |
+| `/agents`          | Show available agents                       |
+| `/models`          | Show available models                       |
+| `/log`             | Enable/disable logging                      |
+| `/run <cmd>`       | Run a shell command from within miniterm    |
+| `/exit` or `/quit` | Exit the application                        |
+
+### File References
+
+Reference files in your conversation using `@` followed by the path:
+
+```
+> Review @src/index.ts and suggest improvements
+```
+
+Tab completion is supported for file paths:
+
+```
+> @sr<tab>  → @src/
+> @src/in<tab>  → @src/index.ts
+```
+
+### Keyboard Shortcuts
+
+| Key                    | Action                       |
+| ---------------------- | ---------------------------- |
+| `↑` / `↓`              | Navigate command history     |
+| `←` / `→`              | Move cursor                  |
+| `Opt+←` / `Opt+→`      | Move by word boundaries      |
+| `Tab`                  | Auto-complete commands/files |
+| `Backspace` / `Delete` | Delete characters            |
+| `Esc`                  | Cancel current request       |
+| `Ctrl+C`               | Force quit application       |
+
+## Session Management
+
+OpenCode Miniterm automatically manages sessions per directory:
+
+- **First Launch**: Creates a new session for the current directory
+- **Subsequent Launches**: Resumes the last session for that directory
+- **New Session**: Use `/new` to create a fresh session
+- **Switch Sessions**: Use `/sessions` to browse and switch between all your sessions
+
+## Development
+
+### Running Locally
+
+```bash
+bun run dev
+# or
+bun src/index.ts
+```
+
+### Build
+
+```bash
+bun build src/index.ts --outdir dist
+```
+
+### Type Check
+
+```bash
+bun run check
+```
+
+### Formatting
+
+```bash
+bunx prettier --write "**/*.{ts,json,md}"
+```
+
+## License
+
+ISC

package/bun.lock

@@ -5,7 +5,7 @@
     "": {
       "name": "opencode-miniterm",
       "dependencies": {
-        "@opencode-ai/sdk": "^1.2.10",
+        "@opencode-ai/sdk": "^1.2.14",
         "allmark": "^1.0.0",
       },
       "devDependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "opencode-miniterm",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"description": "A small front-end terminal UI for OpenCode",
 	"main": "src/index.ts",
 	"bin": {

package/src/commands/diff.ts

@@ -20,7 +20,8 @@ interface DiffLine {
 }
 
 async function run(client: OpencodeClient, state: State): Promise<void> {
-	if (!config.sessionID) {
+	const cwd = process.cwd();
+	if (!config.sessionIDs[cwd]) {
 		console.log("No active session.\n");
 		return;
 	}
@@ -28,7 +29,7 @@ async function run(client: OpencodeClient, state: State): Promise<void> {
 	console.log("Fetching file changes...");
 
 	const result = await client.session.diff({
-		path: { id: config.sessionID },
+		path: { id: config.sessionIDs[cwd] },
 	});
 
 	if (result.error) {

package/src/commands/init.ts

@@ -14,11 +14,12 @@ let command: Command = {
 export default command;
 
 async function run(_client: OpencodeClient, _state: State): Promise<void> {
-	if (!config.sessionID) return;
+	const cwd = process.cwd();
+	if (!config.sessionIDs[cwd]) return;
 
 	console.log("Running /init command (analyzing project and creating AGENTS.md)...");
 	const result = await _client.session.init({
-		path: { id: config.sessionID },
+		path: { id: config.sessionIDs[cwd] },
 	});
 
 	if (result.error) {

package/src/commands/new.ts

@@ -16,7 +16,7 @@ export default command;
 
 async function run(client: OpencodeClient, state: State): Promise<void> {
 	state.sessionID = await createSession(client);
-	config.sessionID = state.sessionID;
+	config.sessionIDs[process.cwd()] = state.sessionID;
 	saveConfig();
 
 	await updateSessionTitle();

package/src/commands/sessions.ts

@@ -44,7 +44,7 @@ async function run(client: OpencodeClient, state: State): Promise<void> {
 	if (sessions.length === 0) {
 		console.log("No sessions found. Creating a new session...");
 		state.sessionID = await createSession(client);
-		config.sessionID = state.sessionID;
+		config.sessionIDs[process.cwd()] = state.sessionID;
 		saveConfig();
 		console.log(`Created new session: ${state.sessionID}...\n`);
 		await updateSessionTitle();
@@ -135,7 +135,7 @@ async function handleKey(_client: OpencodeClient, key: Key, str?: string) {
 			readline.cursorTo(process.stdout, 0);
 			readline.clearScreenDown(process.stdout);
 			if (selected) {
-				config.sessionID = selected.id;
+				config.sessionIDs[process.cwd()] = selected.id;
 				saveConfig();
 				console.log(`Switched to session: ${selected.id.substring(0, 8)}...`);
 				if (selected.title) {
@@ -222,7 +222,7 @@ function renderSessionList(): void {
 			const globalIndex = sessionList.indexOf(session);
 			const filteredIndex = sessionFilteredIndices.indexOf(globalIndex);
 			const isSelected = filteredIndex === selectedSessionIndex;
-			const isActive = session.id === config.sessionID;
+			const isActive = session.id === config.sessionIDs[process.cwd()];
 			const prefix = isSelected ? "  >" : "   -";
 			const title = session.title || "(no title)";
 			const name = isSelected ? `\x1b[33;1m${title}\x1b[0m` : title;
@@ -250,7 +250,7 @@ function updateSessionFilter(): void {
 	}
 	if (sessionFilteredIndices.length > 0) {
 		selectedSessionIndex = sessionFilteredIndices.indexOf(
-			sessionList.findIndex((s) => s.id === config.sessionID),
+			sessionList.findIndex((s) => s.id === config.sessionIDs[process.cwd()]),
 		);
 		if (selectedSessionIndex === -1) selectedSessionIndex = 0;
 	}

package/src/commands/undo.ts

@@ -13,12 +13,13 @@ let command: Command = {
 export default command;
 
 async function run(client: OpencodeClient, _state: State): Promise<void> {
-	if (!config.sessionID) return;
+	const cwd = process.cwd();
+	if (!config.sessionIDs[cwd]) return;
 
 	console.log("Fetching session messages...");
 
 	const messagesRes = await client.session.messages({
-		path: { id: config.sessionID },
+		path: { id: config.sessionIDs[cwd] },
 	});
 
 	if (messagesRes.error) {
@@ -49,7 +50,7 @@ async function run(client: OpencodeClient, _state: State): Promise<void> {
 	console.log(`Reverting last assistant message (${lastMessage.info.id})...`);
 
 	const revertRes = await client.session.revert({
-		path: { id: config.sessionID },
+		path: { id: config.sessionIDs[process.cwd()] },
 		body: {
 			messageID: lastMessage.info.id,
 		},

package/src/config.ts

@@ -5,7 +5,7 @@ export interface Config {
 	providerID: string;
 	modelID: string;
 	agentID: string;
-	sessionID?: string;
+	sessionIDs: Record<string, string>;
 	loggingEnabled: boolean;
 }
 
@@ -15,6 +15,7 @@ export const config: Config = {
 	providerID: "opencode",
 	modelID: "big-pickle",
 	agentID: "build",
+	sessionIDs: {},
 	loggingEnabled: false,
 };
 

package/src/index.ts

@@ -14,7 +14,6 @@ import detailsCommand from "./commands/details";
 import diffCommand from "./commands/diff";
 import exitCommand from "./commands/exit";
 import initCommand from "./commands/init";
-import killCommand from "./commands/kill";
 import logCommand, { isLoggingEnabled } from "./commands/log";
 import modelsCommand from "./commands/models";
 import newCommand from "./commands/new";
@@ -42,7 +41,6 @@ const SLASH_COMMANDS = [
 	debugCommand,
 	logCommand,
 	pageCommand,
-	killCommand,
 	exitCommand,
 	quitCommand,
 	runCommand,
@@ -122,11 +120,11 @@ async function main() {
 	try {
 		let isNewSession = false;
 
-		const initialSessionID = config.sessionID;
+		const initialSessionID = config.sessionIDs[cwd];
 		if (!initialSessionID || !(await validateSession(initialSessionID))) {
 			state.sessionID = await createSession();
 			isNewSession = true;
-			config.sessionID = state.sessionID;
+			config.sessionIDs[cwd] = state.sessionID;
 			saveConfig();
 		} else {
 			state.sessionID = initialSessionID;

package/src/commands/kill.ts

@@ -1,33 +0,0 @@
-import type { OpencodeClient } from "@opencode-ai/sdk";
-import type { State } from "../index";
-import type { Command } from "../types";
-
-let command: Command = {
-	name: "/kill",
-	description: "Abort a session (e.g. `/kill ses_123`)",
-	run,
-	running: false,
-};
-
-export default command;
-
-async function run(client: OpencodeClient, _state: State, input?: string): Promise<void> {
-	if (!input) {
-		console.log("Usage: /kill <session_id>");
-		console.log();
-		return;
-	}
-
-	const result = await client.session.abort({
-		path: { id: input },
-	});
-
-	if (result.error) {
-		throw new Error(
-			`Failed to abort session (${result.response.status}): ${JSON.stringify(result.error)}`,
-		);
-	}
-
-	console.log(`Session aborted successfully.`);
-	console.log();
-}