{"id":50889304,"url":"https://github.com/skwid138/opencode-tui","last_synced_at":"2026-06-15T20:02:17.418Z","repository":{"id":360080330,"uuid":"1248435005","full_name":"skwid138/opencode-tui","owner":"skwid138","description":"Configurable TUI plugin for OpenCode — custom ASCII logo with dual-color theming and randomized prompt placeholders","archived":false,"fork":false,"pushed_at":"2026-05-24T21:55:11.000Z","size":97,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-24T23:29:16.346Z","etag":null,"topics":["cli-customization","npm-package","opencode","opencode-plugin","solid-js","terminal-ui","tui","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skwid138.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-24T16:31:28.000Z","updated_at":"2026-05-24T21:55:15.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/skwid138/opencode-tui","commit_stats":null,"previous_names":["skwid138/opencode-tui"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/skwid138/opencode-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skwid138%2Fopencode-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skwid138%2Fopencode-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skwid138%2Fopencode-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skwid138%2Fopencode-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skwid138","download_url":"https://codeload.github.com/skwid138/opencode-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skwid138%2Fopencode-tui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34377983,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-customization","npm-package","opencode","opencode-plugin","solid-js","terminal-ui","tui","typescript"],"created_at":"2026-06-15T20:02:16.426Z","updated_at":"2026-06-15T20:02:17.402Z","avatar_url":"https://github.com/skwid138.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @skwid138/opencode-tui\n\nLipstick for your OpenCode TUI.\n\n[![npm](https://img.shields.io/npm/v/@skwid138/opencode-tui)](https://npmjs.com/package/@skwid138/opencode-tui) [![CI](https://github.com/skwid138/opencode-tui/actions/workflows/ci.yml/badge.svg)](https://github.com/skwid138/opencode-tui/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n`@skwid138/opencode-tui` is a configurable OpenCode TUI plugin that replaces the home screen logo and prompt placeholders with friendlier defaults. Use it as-is, customize ASCII logo rows with per-segment inline colors, swap prompt suggestions for normal and shell modes, or disable either section independently while invalid config safely falls back to defaults.\n\n## Quick Start\n\nInstall the package:\n\n```sh\nnpm install @skwid138/opencode-tui\n```\n\nAdd the TUI entry to your OpenCode plugin configuration using the package's TUI export:\n\n```jsonc\n{\n  \"plugin\": [\"@skwid138/opencode-tui/tui\"]\n}\n```\n\n## Features\n\n- Custom ASCII logos made from rows of inline text segments.\n- Per-segment logo colors using 3- or 6-digit hex values.\n- Prompt placeholder customization for normal and shell modes.\n- Disable logo or prompt customization independently.\n- Graceful fallback to defaults when config is invalid.\n- Companion Logo Builder web app for generating `logo.rows` config.\n\n## Usage\n\n### Zero config\n\nUse the default JustVibes logo and default prompt placeholders:\n\n```jsonc\n{\n  \"plugin\": [\"@skwid138/opencode-tui/tui\"]\n}\n```\n\nPlugin options are registered as a tuple: `[\"@skwid138/opencode-tui/tui\", { config }]`.\n\n### Disable sections\n\nDisable only the logo:\n\n```jsonc\n{\n  \"plugin\": [\n    [\"@skwid138/opencode-tui/tui\", { \"logo\": false }]\n  ]\n}\n```\n\nDisable only the prompt override:\n\n```jsonc\n{\n  \"plugin\": [\n    [\"@skwid138/opencode-tui/tui\", { \"prompt\": false }]\n  ]\n}\n```\n\nDisable both sections:\n\n```jsonc\n{\n  \"plugin\": [\n    [\"@skwid138/opencode-tui/tui\", { \"logo\": false, \"prompt\": false }]\n  ]\n}\n```\n\n### Custom prompts\n\n```jsonc\n{\n  \"plugin\": [\n    [\n      \"@skwid138/opencode-tui/tui\",\n      {\n        \"prompt\": {\n          \"placeholders\": {\n            \"normal\": [\n              \"Build a dashboard for my team\",\n              \"Refactor this component\",\n              \"Help me debug this error\"\n            ],\n            \"shell\": [\n              \"List files by size\",\n              \"Show current git status\"\n            ]\n          }\n        }\n      }\n    ]\n  ]\n}\n```\n\n### Custom logo rows\n\nEach row contains literal pre-rendered ASCII text segments. Segment `color` is an inline 3- or 6-digit hex string including `#`.\n\n```jsonc\n{\n  \"plugin\": [\n    [\n      \"@skwid138/opencode-tui/tui\",\n      {\n        \"logo\": {\n          \"rows\": [\n            {\n              \"segments\": [\n                { \"text\": \"Open\", \"color\": \"#5DBDB3\" },\n                { \"text\": \"Code\", \"color\": \"#F8B4C4\" }\n              ]\n            }\n          ]\n        }\n      }\n    ]\n  ]\n}\n```\n\n## Options reference\n\n| Option | Type | Default | Description |\n| --- | --- | --- | --- |\n| `logo` | `false \\| LogoConfig` | default logo | Set to `false` to leave `home_logo` untouched. |\n| `logo.rows` | `Array\u003c{ segments: Array\u003c{ text: string; color: string }\u003e }\u003e` | JustVibes ASCII art | Logo rows rendered as horizontal text segments. Segment colors must match `#RGB` or `#RRGGBB`. Empty arrays fall back to defaults. |\n| `prompt` | `false \\| PromptConfig` | default prompt | Set to `false` to leave `home_prompt` untouched. |\n| `prompt.placeholders.normal` | `string[]` | 11 default ideas | Suggestions for normal prompt mode. Empty arrays fall back to defaults. |\n| `prompt.placeholders.shell` | `string[]` | 3 default shell ideas | Suggestions for shell prompt mode. Empty arrays fall back to defaults. |\n\nInvalid sections are isolated: a bad `logo` config falls back to the default logo without breaking prompt customization, and a bad `prompt` config falls back without breaking the logo. Validation never throws; warnings are logged and surfaced through the OpenCode toast API when available.\n\n## Logo Builder\n\nUse the companion Logo Builder app to generate custom `logo.rows` config: \u003chttps://skwid138.github.io/opencode-logo-builder/\u003e. The companion repo lives at \u003chttps://github.com/skwid138/opencode-logo-builder\u003e.\n\n## Development\n\nInstall dependencies:\n\n```sh\nnpm install\n```\n\nRun tests:\n\n```sh\nnpm test\n```\n\nRun tests with coverage:\n\n```sh\nnpm run test:coverage\n```\n\nType-check:\n\n```sh\nnpm run typecheck\n```\n\nBuild the package:\n\n```sh\nnpm run build\n```\n\nThe build emits ESM artifacts and declaration files into `dist/`.\n\n\u003c!-- keep in sync with opencode-council and opencode-tui --\u003e\n### Commit messages\n\nThis repo uses [Conventional Commits](https://www.conventionalcommits.org/). A local\n[husky](https://typicode.github.io/husky/) hook runs\n[commitlint](https://commitlint.js.org/) on every commit, and PR titles are validated\nby GitHub Actions (`.github/workflows/pr-title.yml`) since this repo squash-merges\nwith the PR title as the commit subject.\n\nAllowed types: `feat`, `fix`, `perf`, `refactor` (patch), `docs`, `chore`, `ci`,\n`style`, `test`, `build`, `revert`.\n\nNotes:\n- Use `git commit --no-verify` to bypass the hook in unusual cases (e.g. WIP commits\n  you'll squash later).\n- A `BREAKING CHANGE:` footer in the commit body triggers a major release regardless\n  of the type prefix — use deliberately.\n- The conventional prefix governs the release type, but the human is responsible for\n  matching prefix to actual change (a `feat:` whose diff is a README typo will still\n  publish a minor release).\n\n## License\n\nMIT © [Spencer Miller](https://github.com/skwid138)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskwid138%2Fopencode-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskwid138%2Fopencode-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskwid138%2Fopencode-tui/lists"}