{"id":39217655,"url":"https://github.com/boolean-maybe/tiki","last_synced_at":"2026-04-03T06:05:34.889Z","repository":{"id":333611332,"uuid":"1136396151","full_name":"boolean-maybe/tiki","owner":"boolean-maybe","description":"Markdown-based git-versioned documentation and issue management","archived":false,"fork":false,"pushed_at":"2026-04-01T03:48:57.000Z","size":23683,"stargazers_count":134,"open_issues_count":10,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-01T04:24:00.353Z","etag":null,"topics":["cli","go","golang","hacktoberfest","issue-management","kanban","kanban-board","linux","macos","markdown","markdown-viewer","project-management","terminal","tui","windows"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boolean-maybe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-01-17T16:07:35.000Z","updated_at":"2026-04-01T03:43:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/boolean-maybe/tiki","commit_stats":null,"previous_names":["boolean-maybe/tiki"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/boolean-maybe/tiki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolean-maybe%2Ftiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolean-maybe%2Ftiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolean-maybe%2Ftiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolean-maybe%2Ftiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boolean-maybe","download_url":"https://codeload.github.com/boolean-maybe/tiki/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolean-maybe%2Ftiki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31338368,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T04:42:29.251Z","status":"ssl_error","status_checked_at":"2026-04-03T04:42:12.667Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","go","golang","hacktoberfest","issue-management","kanban","kanban-board","linux","macos","markdown","markdown-viewer","project-management","terminal","tui","windows"],"created_at":"2026-01-17T23:24:46.624Z","updated_at":"2026-04-03T06:05:34.881Z","avatar_url":"https://github.com/boolean-maybe.png","language":"Go","readme":"Follow me on X: [![X Badge](https://img.shields.io/badge/-%23000000.svg?style=flat-square\u0026logo=X\u0026logoColor=white)](https://x.com/booleanandmaybe)\n\n# tiki\n\n**UPDATE**:\n\nAdded test files. Try (must be the latest release):\n```\ntiki https://github.com/boolean-maybe/tiki/blob/main/testdata/go-concurrency.md\n```\n\n**UPDATE**:\n\nNew `chat with AI` action - open a tiki and press `c - Chat`. Opens your preferred terminal coding agent like\n[Claude Code](https://code.claude.com) and loads tiki description. You can chat or edit the tiki with your agent\n\n\nAgent must be configured in `config.yaml`:\n```yaml\nai:\n  agent: [claude, codex, gemini, opencode]\n```\n\n**UPDATE**:\n\nNow support images and Mermaid diagrams in Kitty-compatible terminals (iTerm2, Kitty, WezTerm, Ghostty)\n\n![Intro](assets/images.gif)\n\nsupported:\n- PNG, JPEG, GIF, BMP, WebP, TIFF\n- SVG\n- Mermaid diagram blocks\n\nsee [requirements](.doc/doki/doc/image-requirements.md) for more details\n\n\n`tiki` is a simple and lightweight way to keep your tasks, prompts, documents, ideas, scratchpads in your project **git** repo\n\n![Intro](assets/intro.png)\n\n[Documentation](.doc/doki/doc/index.md)\n\nMarkdown is the new go-to format for everything, it's simple, efficient, human and AI native - project management, \ndocumentation, brainstorming ideas, incomplete implementations, AI prompts and plans and what not are saved as Markdown files. \nStick them in your repo. Keep around for as long as you need. Find them back in **git** history. Make issues out of them\nand take them through an agile lifecycle. `tiki` helps you save and organize these files:\n\n- Standalone **Markdown viewer** - view and edit Markdown or image files, navigate to local/external/GitHub/GitLab links, image display\n- Keep, search, view and version Markdown files in the **git repo**\n- **Wiki-style** documentation with multiple entry points\n- Keep a **to-do list** with priorities, status, assignee and size\n- Issue management with **Kanban/Scrum** style board and burndown chart\n- **Plugin-first** architecture - user-defined plugins with filters and actions like Backlog, Recent, Roadmap\n- AI **skills** to enable [Claude Code](https://code.claude.com), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Codex](https://openai.com/codex), [Opencode](https://opencode.ai) work with natural language commands like\n  \"_create a tiki from @my-file.md_\"\n  \"_mark tiki ABC123 as complete_\"\n\n## Installation\n\n### Mac OS and Linux\n```bash\ncurl -fsSL https://raw.githubusercontent.com/boolean-maybe/tiki/main/install.sh | bash\n```\n\n\n### Mac OS via brew\n```bash\nbrew install boolean-maybe/tap/tiki\n```\n\n### Windows\n```powershell\n# Windows PowerShell\niwr -useb https://raw.githubusercontent.com/boolean-maybe/tiki/main/install.ps1 | iex\n```\n\n### Manual install\n\nDownload the latest distribution from the [releases page](https://github.com/boolean-maybe/tiki/releases) \nand simply copy the `tiki` executable to any location and make it available via `PATH`\n\n### Build from source\n\n```bash\ngit clone https://github.com/boolean-maybe/tiki.git\ncd tiki\nmake build install\n```\n\n### Verify installation\n```bash\ntiki --version\ntiki --help\n```\n\n## Quick start\n\n### Markdown viewer\n\n\u003cimg src=\".doc/doki/doc/markdown-viewer.gif\" alt=\"Markdown viewer demo\" width=\"800\"\u003e\n\n`tiki my-markdownfile` to view, edit and navigate markdown files in terminal.\nif you have no Markdown file to try - use this:\n```\ntiki https://github.com/boolean-maybe/tiki/blob/main/testdata/go-concurrency.md\n```\n\n\nAll vim-like pager commands are supported in addition to:\n- `Tab/Enter` to select and load a link in the document\n- `e` to edit it in your favorite editor\n\n### File and issue management\n\n\u003cimg src=\".doc/doki/doc/kanban.gif\" alt=\"Kanban demo\" width=\"800\"\u003e\n\nto try with a demo project just run:\n\n```\ncd /tmp \u0026\u0026 tiki demo\n```\n\nthis will clone and show a demo project. Once done you can try your own:\n\n`cd` into your **git** repo and run `tiki init` to initialize.\nMove your tiki around the board with `Shift ←/Shift →`.\nMake sure to press `?` for help.\nPress `F1` to open a sample doc root. Follow links with `Tab/Enter`\n\n### AI skills\nYou will be prompted to install skills for\n- [Claude Code](https://code.claude.com)\n- [Gemini CLI](https://github.com/google-gemini/gemini-cli)\n- [Codex](https://openai.com/codex)\n- [Opencode](https://opencode.ai)\n\nif you choose to you can mention `tiki` in your prompts to create/find/edit your tikis\n![Claude](assets/claude.png)\n\n### Quick capture\n\nQuick capture ideas by redirecting to `tiki`:\n```bash\necho \"cool idea\" | tiki\ngh issue view 42 --json title,body -q '\"\\(.title)\\n\\n\\(.body)\"' | tiki\ncurl -s https://sentry.io/api/issues/latest/ | jq -r '.title' | tiki\ngrep ERROR server.log | sort -u | while read -r line; do echo \"$line\" | tiki; done\n```\n\nRead more [quick capture docs](.doc/doki/doc/quick-capture.md).\n\nHappy tikking! \n\n## tiki\nKeep your tickets in your pockets!\n\n`tiki` refers to a task or a ticket (hence tiki) stored in your **git** repo\n\n- like a ticket it can have a status, priority, assignee, points, type and multiple tags attached to it\n- they are essentially just Markdown files and you can use full Markdown syntax to describe a story or a bug\n- they are stored in `.doc/tiki` subdirectory and are **git**-controlled - they are added to **git** when they are created,\nremoved when they are done and the entire history is preserved in **git** repo\n- because they are in **git** they can be perfectly synced up to the state of your repo or a branch\n- you can use either the `tiki` CLI tool or any of the AI coding assistant to work with your tikis\n\n## doki\nStore your notes in remotes!\n\n`doki` refers to any file in Markdown format that is stored in the `.doc/doki` subdirectory of the **git** repo. \n\n- like tikis they are **git**-controlled and can be maintained in perfect sync with the repo state\n- `tiki` CLI tool allows creating multiple doc roots like: Documentation, Brainstorming, Prompts etc.\n- it also allows viewing and navigation (follow links)\n\n## tiki TUI tool\n\n`tiki` TUI tool allows creating, viewing, editing and deleting tikis as well as creating custom plugins to \nview any selection, for example, Recent tikis, Architecture docs, Saved prompts, Security review, Future Roadmap\nRead more by pressing `?` for help \n\n## AI skills\n\n`tiki` adds optional [agent skills](https://agentskills.io/home) to the repo upon initialization\nIf installed you can:\n\n- work with [Claude Code](https://code.claude.com), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Codex](https://openai.com/codex), [Opencode](https://opencode.ai) by simply mentioning `tiki` or `doki` in your prompts\n- create, find, modify and delete tikis using AI\n- create tikis/dokis directly from Markdown files\n- Refer to tikis or dokis when implementing with AI-assisted development - `implement tiki xxxxxxx`\n- Keep a history of prompts/plans by saving prompts or plans with your repo\n\n## Feedback\n\nFeedback is always welcome! Whether you have an improvement request, a feature suggestion\nor just chat:\n- use GitHub issues to submit and issue or a feature request\n- use GitHub discussions for everything else\n- follow and DM on [X](https://x.com/booleanandmaybe)\n\nto contribute:\n[Contributing](CONTRIBUTING.md)\n\n## Badges\n\n![Build Status](https://github.com/boolean-maybe/tiki/actions/workflows/go.yml/badge.svg)\n[![Go Report Card](https://goreportcard.com/badge/github.com/boolean-maybe/tiki)](https://goreportcard.com/report/github.com/boolean-maybe/tiki)\n[![Go Reference](https://pkg.go.dev/badge/github.com/boolean-maybe/tiki.svg)](https://pkg.go.dev/github.com/boolean-maybe/tiki)\n","funding_links":[],"categories":["Table of Contents"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboolean-maybe%2Ftiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboolean-maybe%2Ftiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboolean-maybe%2Ftiki/lists"}