docs

Download the latest build for your platform: macOS (universal) or Linux (.deb). Chikamichi runs on macOS (Apple Silicon & Intel) and Debian-based Linux. Windows support is coming soon.

On macOS, drag the app into Applications and open it. On Linux, install the .deb with sudo apt install ./chikamichi_linux_amd64.deb.

Chikamichi uses GitHub's device flow, so you never type your password into the app:

1. Open chikamichi — it shows a short one-time code.
2. Visit github.com/login/device in your browser and enter the code.
3. Approve the access, and the app signs in automatically.

Your session is remembered between launches. You can sign out any time from Settings.

Browsing is free forever. Pick any repository you have access to and chikamichi renders its Markdown files beautifully — headings, tables, code blocks, the lot — no raw syntax in sight.

With a Pro license, the viewer becomes a WYSIWYG editor. You see styled text as you type, like a word processor, and can toggle to raw Markdown whenever you want.

• Save = commit. Press save and your change commits straight to GitHub. No terminal, no pull requests.
• Branches. Create and switch branches from the sidebar, so your edits land on the right one.
• Auto-fork. No write access? Chikamichi offers to fork the repo for you and commits to your fork instead.
• Conflict resolution. If someone else edited the file since you opened it, you get a visual diff and choose how to resolve it.

Pro is a one-time $9.99 purchase — no subscription. Click Get Pro Access in the app's Settings to open checkout. After payment you land on a page showing your license key (bookmark it — reopening that link always shows the same key).

To activate, paste the key into the license field in Settings and confirm. The key works offline once activated.

Lost your key? Reopen the link from your purchase, or email support@chikamichi.dev with your receipt.

• GitHub sign-in stopped working? Sign out from Settings and sign in again — sessions can expire if you revoke the app's access on GitHub.
• License key rejected? Make sure you pasted the whole key, including the CHKM- prefix, with no surrounding spaces.
• Something else? Ask in GitHub Discussions or email support@chikamichi.dev.