@codeworksh/tui 0.0.0-stage → 0.0.1-canary.33.1.g4dc50635

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sanchit Kudari <0xsanchit@gmail.com> & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,130 @@
-# Temporary Holding Version
+# codework-tui
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A fast and lightweight terminal interface for [CodeWork](https://www.codework.sh), written in **Rust**.
+
+`codework-tui` lets you chat with your AI coding agent directly from your terminal. Watch it write code, run tools, and edit files in real time, all while keeping track of token usage and costs.
+
+---
+
+## Features
+
+- **Fast and Lightweight** — Starts up instantly and uses minimal memory.
+- **Live Streaming** — Watch the AI think, stream answers, and run tools (like running terminal commands or editing files) as it happens.
+- **Side-by-Side View** —
+   - **Chat screen:** See your conversation, AI replies, tool results, and response speed (`tok/s`).
+   - **Sidebar:** Keep an eye on your current model, context window usage, tokens used, cost, and active Git branch.
+- **Easy Model Picker (`/model`)** — Browse models (Anthropic, OpenAI, Google, OpenRouter, Groq), check pricing, and enter API keys directly in the terminal.
+- **Neat Markdown Formatting** — Code blocks, lists, bold text, links, and tables look clean and readable in the terminal.
+- **Cancel Anytime** — Press `Esc` or `Ctrl+C` while the AI is responding to safely stop it without losing your conversation or quitting the app.
+- **Auto-Connect** — `codework tui` starts or reuses the CodeWork background server, then connects the UI to it.
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+- [Rust](https://rustup.rs/) (latest stable version)
+- Node.js and pnpm (to run the CodeWork CLI and background server)
+
+### Running the App
+
+`codework tui` is the normal way in: the CLI starts or reuses the background server (registered in `<home>/service.json`) and launches this binary with `CODEWORK_RPC_SERVER` set. From a checkout it picks up a `target/{release,debug}` build.
+
+To run the binary directly against a server you started with `codework serve`, use Cargo:
+
+```bash
+# Run in development mode
+cargo run
+
+# Build and run an optimized release version
+cargo build --release
+./target/release/codework-tui
+```
+
+Or using pnpm:
+
+```bash
+# From packages/tui
+pnpm start
+
+# Or from the project root
+pnpm --filter @codeworksh/tui start
+```
+
+---
+
+## Commands
+
+Type `/` in the prompt input to open the command menu:
+
+| Command    | What it does                                |
+| :--------- | :------------------------------------------ |
+| `/help`    | Show available commands and shortcuts       |
+| `/model`   | Pick an AI model or enter API keys          |
+| `/session` | View, switch, or resume past sessions       |
+| `/compact` | Shorten conversation history to save tokens |
+| `/clear`   | Clear the current chat screen               |
+| `/exit`    | Exit the app                                |
+
+---
+
+## Keyboard Shortcuts
+
+### General & Chat
+
+| Shortcut              | Action                                                            |
+| :-------------------- | :---------------------------------------------------------------- |
+| `Enter`               | Send message / run command                                        |
+| `Esc`                 | Close popup, cancel current action, or stop the AI                |
+| `Ctrl+C`              | Stop the AI response / exit app when idle                         |
+| `PageUp` / `PageDown` | Scroll chat up or down by a full page                             |
+| `Ctrl+U` / `Ctrl+D`   | Scroll chat up or down by half a page                             |
+| `Home` / `End`        | Jump to the very top or bottom of the chat                        |
+| `Up` / `Down`         | Move through slash commands (or scroll lines when input is empty) |
+
+### Model Picker (`/model`)
+
+| Shortcut                     | Action                                              |
+| :--------------------------- | :-------------------------------------------------- |
+| `Tab` / `Shift+Tab`          | Move between Providers, Models, and Details columns |
+| `Up` / `Down` (or `j` / `k`) | Move through the list                               |
+| `/`                          | Search models or providers                          |
+| `s`                          | Change sort order (by name, context size, cost)     |
+| `c` / `y`                    | Copy the selected model ID to clipboard             |
+| `o`                          | Open provider website in your browser               |
+| `Enter`                      | Select the model (asks for an API key if needed)    |
+
+---
+
+## API Keys & Settings
+
+You can provide API keys in two simple ways:
+
+1. **Inside the app:** Type `/model`, choose a provider, and enter your API key when prompted.
+2. **Environment variables:** Export the key in your terminal before running:
+   ```bash
+   export ANTHROPIC_API_KEY="your-key-here"
+   export OPENAI_API_KEY="your-key-here"
+   export GEMINI_API_KEY="your-key-here"
+   export OPENROUTER_API_KEY="your-key-here"
+   export GROQ_API_KEY="your-key-here"
+   ```
+
+Your configuration and keys are saved in your home folder:
+
+- **`~/.codework/config.json`** — Your selected model and provider.
+- **`~/.codework/credentials.json`** — Your securely stored API keys.
+
+---
+
+## Contributors
+
+- **Prem** ([@prem315](https://github.com/prem315))
+- **Sanchit** ([@sanchitrk](https://github.com/sanchitrk))
+
+---
+
+## License
+
+MIT © [CodeWork](https://codework.sh)

package/index.mjs

@@ -0,0 +1,64 @@
+import { createRequire } from "node:module";
+import { existsSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+//#region src/binary.ts
+const require = createRequire(import.meta.url);
+/** Resolve the current platform, or `undefined` where no prebuilt is published. */
+function platform() {
+	const os = process.platform;
+	const arch = process.arch;
+	if (os !== "darwin" && os !== "linux") return void 0;
+	if (arch !== "arm64" && arch !== "x64") return void 0;
+	return {
+		os,
+		arch
+	};
+}
+const packageFor = (value) => `@codeworksh/tui-${value.os}-${value.arch}`;
+const binaryName = "codework-tui";
+/** A source-tree build, used when neither an override nor a platform package is present. */
+function devBuild() {
+	for (const profile of ["release", "debug"]) {
+		const candidate = fileURLToPath(new URL(`../target/${profile}/${binaryName}`, import.meta.url));
+		if (existsSync(candidate)) return candidate;
+	}
+}
+var LauncherError = class extends Error {};
+/**
+* The `codework-tui` executable to run.
+*
+* Resolution order, most specific first:
+* 1. `CODEWORK_TUI_BIN` — an explicit path, for a local build or a test.
+* 2. The platform package's `bin/` — what a normal install ships.
+* 3. A `target/{release,debug}` build in the source tree, so `codework tui`
+*    works from a checkout without publishing anything.
+*
+* Nothing is ever downloaded: a missing binary is an error that names the
+* package to install, because a silent runtime fetch is both surprising and a
+* supply-chain surface.
+*/
+function resolveBinary(env = process.env) {
+	const override = env["CODEWORK_TUI_BIN"];
+	if (override !== void 0 && override.length > 0) {
+		if (!existsSync(override)) throw new LauncherError(`CODEWORK_TUI_BIN points at a missing file: ${override}`);
+		return override;
+	}
+	const current = platform();
+	if (current !== void 0) try {
+		const manifest = require.resolve(`${packageFor(current)}/package.json`);
+		const binary = join(dirname(manifest), "bin", binaryName);
+		if (existsSync(binary)) return binary;
+	} catch {}
+	const dev = devBuild();
+	if (dev !== void 0) return dev;
+	throw new LauncherError(current === void 0 ? `no prebuilt CodeWork TUI is published for ${process.platform}-${process.arch}` : `the CodeWork TUI binary is missing. Install ${packageFor(current)}, or build it with \`cargo build --release\` in packages/tui`);
+}
+//#endregion
+//#region src/index.ts
+/** The environment variable the Rust TUI reads for the server endpoint. */
+const ENV_SERVER = "CODEWORK_RPC_SERVER";
+//#endregion
+export { ENV_SERVER, LauncherError, platform, resolveBinary };
+
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/binary.ts","../../src/index.ts"],"sourcesContent":["/* @effect-diagnostics nodeBuiltinImport:off -- the launcher resolves a file on the host. */\nimport { createRequire } from \"node:module\";\nimport { existsSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst require = createRequire(import.meta.url);\n\n/** The Rust binary, by the package that publishes a prebuilt for this platform. */\nexport interface Platform {\n\treadonly os: \"darwin\" | \"linux\";\n\treadonly arch: \"arm64\" | \"x64\";\n}\n\n/** Resolve the current platform, or `undefined` where no prebuilt is published. */\nexport function platform(): Platform | undefined {\n\tconst os = process.platform;\n\tconst arch = process.arch;\n\tif (os !== \"darwin\" && os !== \"linux\") return undefined;\n\tif (arch !== \"arm64\" && arch !== \"x64\") return undefined;\n\treturn { os, arch };\n}\n\nconst packageFor = (value: Platform) => `@codeworksh/tui-${value.os}-${value.arch}`;\nconst binaryName = \"codework-tui\";\n\n/** A source-tree build, used when neither an override nor a platform package is present. */\nfunction devBuild(): string | undefined {\n\tfor (const profile of [\"release\", \"debug\"]) {\n\t\tconst candidate = fileURLToPath(new URL(`../target/${profile}/${binaryName}`, import.meta.url));\n\t\tif (existsSync(candidate)) return candidate;\n\t}\n\treturn undefined;\n}\n\nexport class LauncherError extends Error {}\n\n/**\n * The `codework-tui` executable to run.\n *\n * Resolution order, most specific first:\n * 1. `CODEWORK_TUI_BIN` — an explicit path, for a local build or a test.\n * 2. The platform package's `bin/` — what a normal install ships.\n * 3. A `target/{release,debug}` build in the source tree, so `codework tui`\n *    works from a checkout without publishing anything.\n *\n * Nothing is ever downloaded: a missing binary is an error that names the\n * package to install, because a silent runtime fetch is both surprising and a\n * supply-chain surface.\n */\nexport function resolveBinary(env: NodeJS.ProcessEnv = process.env): string {\n\tconst override = env[\"CODEWORK_TUI_BIN\"];\n\tif (override !== undefined && override.length > 0) {\n\t\tif (!existsSync(override)) throw new LauncherError(`CODEWORK_TUI_BIN points at a missing file: ${override}`);\n\t\treturn override;\n\t}\n\n\tconst current = platform();\n\tif (current !== undefined) {\n\t\ttry {\n\t\t\t// Resolve through the package's own manifest so the binary path is not part of\n\t\t\t// the platform package's public `exports` surface.\n\t\t\tconst manifest = require.resolve(`${packageFor(current)}/package.json`);\n\t\t\t// In a checkout the platform package is a workspace link with no binary staged.\n\t\t\tconst binary = join(dirname(manifest), \"bin\", binaryName);\n\t\t\tif (existsSync(binary)) return binary;\n\t\t} catch {\n\t\t\t// Fall through to the source-tree build below.\n\t\t}\n\t}\n\n\tconst dev = devBuild();\n\tif (dev !== undefined) return dev;\n\n\tthrow new LauncherError(\n\t\tcurrent === undefined\n\t\t\t? `no prebuilt CodeWork TUI is published for ${process.platform}-${process.arch}`\n\t\t\t: `the CodeWork TUI binary is missing. Install ${packageFor(current)}, or build it with \\`cargo build --release\\` in packages/tui`,\n\t);\n}\n","/**\n * Finds the CodeWork TUI binary. Running it is the CLI's job: the child must\n * share the CLI's lifetime and terminal, which the CLI's own runtime manages.\n */\nexport { LauncherError, platform, resolveBinary, type Platform } from \"./binary.ts\";\n\n/** The environment variable the Rust TUI reads for the server endpoint. */\nexport const ENV_SERVER = \"CODEWORK_RPC_SERVER\";\n"],"mappings":";;;;;AAMA,MAAM,UAAU,cAAc,YAAY,GAAG;;AAS7C,SAAgB,WAAiC;CAChD,MAAM,KAAK,QAAQ;CACnB,MAAM,OAAO,QAAQ;CACrB,IAAI,OAAO,YAAY,OAAO,SAAS,OAAO,KAAA;CAC9C,IAAI,SAAS,WAAW,SAAS,OAAO,OAAO,KAAA;CAC/C,OAAO;EAAE;EAAI;CAAK;AACnB;AAEA,MAAM,cAAc,UAAoB,mBAAmB,MAAM,GAAG,GAAG,MAAM;AAC7E,MAAM,aAAa;;AAGnB,SAAS,WAA+B;CACvC,KAAK,MAAM,WAAW,CAAC,WAAW,OAAO,GAAG;EAC3C,MAAM,YAAY,cAAc,IAAI,IAAI,aAAa,QAAQ,GAAG,cAAc,YAAY,GAAG,CAAC;EAC9F,IAAI,WAAW,SAAS,GAAG,OAAO;CACnC;AAED;AAEA,IAAa,gBAAb,cAAmC,MAAM,CAAC;;;;;;;;;;;;;;AAe1C,SAAgB,cAAc,MAAyB,QAAQ,KAAa;CAC3E,MAAM,WAAW,IAAI;CACrB,IAAI,aAAa,KAAA,KAAa,SAAS,SAAS,GAAG;EAClD,IAAI,CAAC,WAAW,QAAQ,GAAG,MAAM,IAAI,cAAc,8CAA8C,UAAU;EAC3G,OAAO;CACR;CAEA,MAAM,UAAU,SAAS;CACzB,IAAI,YAAY,KAAA,GACf,IAAI;EAGH,MAAM,WAAW,QAAQ,QAAQ,GAAG,WAAW,OAAO,EAAE,cAAc;EAEtE,MAAM,SAAS,KAAK,QAAQ,QAAQ,GAAG,OAAO,UAAU;EACxD,IAAI,WAAW,MAAM,GAAG,OAAO;CAChC,QAAQ,CAER;CAGD,MAAM,MAAM,SAAS;CACrB,IAAI,QAAQ,KAAA,GAAW,OAAO;CAE9B,MAAM,IAAI,cACT,YAAY,KAAA,IACT,6CAA6C,QAAQ,SAAS,GAAG,QAAQ,SACzE,+CAA+C,WAAW,OAAO,EAAE,6DACvE;AACD;;;;ACxEA,MAAa,aAAa"}

package/package.json

@@ -1,6 +1,38 @@
 {
-  "name": "@codeworksh/tui",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@codeworksh/tui",
+	"version": "0.0.1-canary.33.1.g4dc50635",
+	"description": "High-performance Terminal User Interface (TUI) for CodeWork in Rust, with a thin TypeScript launcher",
+	"keywords": [
+		"codework",
+		"ratatui",
+		"rust",
+		"tui"
+	],
+	"homepage": "https://www.codework.sh",
+	"license": "MIT",
+	"author": "Prem (https://github.com/prem315)",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/codeworksh/codework.git",
+		"directory": "packages/tui"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./index.mjs",
+			"default": "./index.mjs"
+		},
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"**/*",
+		"README.md",
+		"LICENSE"
+	],
+	"optionalDependencies": {
+		"@codeworksh/tui-darwin-arm64": "0.0.1-canary.33.1.g4dc50635",
+		"@codeworksh/tui-darwin-x64": "0.0.1-canary.33.1.g4dc50635",
+		"@codeworksh/tui-linux-arm64": "0.0.1-canary.33.1.g4dc50635",
+		"@codeworksh/tui-linux-x64": "0.0.1-canary.33.1.g4dc50635"
+	}
+}