{"id":32613779,"url":"https://github.com/roblillack/piki","last_synced_at":"2026-05-05T18:33:00.609Z","repository":{"id":321244670,"uuid":"1071390331","full_name":"roblillack/piki","owner":"roblillack","description":"A simple personal wiki","archived":false,"fork":false,"pushed_at":"2025-10-28T07:27:13.000Z","size":2837,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-28T17:21:00.869Z","etag":null,"topics":["cli","fltk","gui","linux-app","macos-app","note-taking","note-taking-app","notes","personal-information-management","rich-text-editor","rust","windows-app"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roblillack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-10-07T09:33:11.000Z","updated_at":"2025-10-28T07:33:21.000Z","dependencies_parsed_at":"2025-10-28T17:31:56.379Z","dependency_job_id":null,"html_url":"https://github.com/roblillack/piki","commit_stats":null,"previous_names":["roblillack/piki"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/roblillack/piki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roblillack%2Fpiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roblillack%2Fpiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roblillack%2Fpiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roblillack%2Fpiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roblillack","download_url":"https://codeload.github.com/roblillack/piki/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roblillack%2Fpiki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281544195,"owners_count":26519554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-29T02:00:06.901Z","response_time":59,"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","fltk","gui","linux-app","macos-app","note-taking","note-taking-app","notes","personal-information-management","rich-text-editor","rust","windows-app"],"created_at":"2025-10-30T15:27:45.947Z","updated_at":"2025-10-30T15:27:46.535Z","avatar_url":"https://github.com/roblillack.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ✜ Piki\n\n[![Build Status](https://github.com/roblillack/piki/workflows/Build,%20Lint,%20and%20Test/badge.svg)](https://github.com/roblillack/piki/actions)\n[![Crates.io](https://img.shields.io/crates/v/piki.svg)](https://crates.io/crates/piki)\n[![Downloads](https://img.shields.io/crates/d/piki.svg)](https://crates.io/crates/piki)\n[![Docs.rs](https://docs.rs/piki-core/badge.svg)](https://docs.rs/piki-core)\n\n**A personal wiki system for your markdown files**\n\nPiki helps you manage a personal knowledge base using plain Markdown files stored on your filesystem. Take notes, create documentation, build your own wiki—all without cloud services, subscriptions, or lock-in.\n\n![Piki Screenshot](./assets/2025-10-28-screenshot-mac.png)\n\n## Features\n\n- **Local-first**: Your notes are plain Markdown files on your filesystem\n- **Git-friendly**: Version control your wiki with Git (optional)\n- **Dual interface**: Use the CLI for quick edits or the GUI for rich text editing\n- **Cross-platform**: Works on Windows, macOS, Linux, and BSD\n- **Lightweight**: GUI built with FLTK featuring a custom rich-text editor\n- **Fast**: Written in Rust for performance and reliability\n- **Private**: No cloud service, no telemetry, no tracking\n- **Open source**: MIT licensed\n\n## Installation\n\n### Via Cargo\n\n```bash\ncargo install piki\ncargo install piki-gui\n```\n\n### System Requirements\n\n- Rust 2024 edition (for building from source)\n- For GUI: FLTK dependencies\n  - **macOS**: No additional dependencies\n  - **Linux/BSD**: Wayland/X11 development libraries\n  - **Windows**: No additional dependencies\n\n## Quick Start\n\n### 1. Initialize Your Wiki\n\nCreate a directory for your notes (or use an existing one):\n\n```bash\nmkdir ~/.piki\ncd ~/.piki\n\n# Create a frontpage\necho \"# John Doe's Brain\" \u003e frontpage.md\n```\n\n### 2. Launch the GUI\n\n```bash\npiki-gui\n```\n\nThe GUI will open with your frontpage. Start editing, create links, and navigate between pages.\n\n### 3. Or Use the CLI\n\n```bash\n# Edit interactively (fuzzy picker)\npiki\n\n# Edit a specific note\npiki edit frontpage\n\n# List all notes\npiki ls\n\n# View a note\npiki view frontpage\n```\n\n## Configuration\n\nCreate a `~/.pikirc` file to customize your workflow:\n\n```toml\n[aliases]\n# Daily notes\ntoday = \"code . -g daily/$(date +'%Y-%m-%d').md\"\nstandup = \"vim work/standup-$(date +'%Y').md\"\n\n# Git shortcuts\nstatus = \"git status -u\"\nsync = \"git ci -m 'Auto-sync' \u0026\u0026 git pull --rebase \u0026\u0026 git push\"\npush = \"git commit -m 'Auto-sync' \u0026\u0026 git push\"\n\n# Open in your favorite editor/IDE\ncode = \"code .\"\ncfg = \"vim ~/.pikirc\"\n\n# Launch GUI from CLI\ng = \"piki-gui\"\n```\n\n## CLI Usage\n\n### Commands\n\n```bash\npiki [options] [command]\n\nOptions:\n  -d, --directory DIRECTORY   Directory containing markdown files (default: ~/.piki)\n\nCommands:\n  edit [name]   Edit a note (opens in $EDITOR or $VISUAL, defaults to vim)\n  view [name]   View a note\n  ls            List all notes\n  log [-n NUM]  Show git commit log (if using git)\n  run [cmd]     Run a shell command inside the notes directory\n  help          Show help information\n```\n\n### Interactive Mode\n\nWhen no command is specified, Piki opens an interactive fuzzy picker:\n\n```bash\npiki -d ~/my-wiki\n# Type to filter notes, arrow keys to navigate, Enter to edit\n```\n\n### Example Workflows\n\n```bash\n# Daily note workflow\npiki edit \"daily/$(date +'%Y-%m-%d')\"\n\n# Quick capture\npiki edit inbox\n\n# Browse and edit\npiki -d ~/my-wiki  # Interactive picker\n\n# View without editing\npiki view project-ideas\n\n# Git integration\npiki run git status\npiki log -n 10\n```\n\n## GUI Usage\n\n### Launching\n\n```bash\n# Open to frontpage\npiki-gui\n\n# Open with custom wiki path\npiki-gui -d /path/to/wiki\n```\n\n### Key Features\n\n**Rich-Text Editing**\n\n- Live Markdown rendering as you type\n- Headers (H1, H2, H3) with visual hierarchy\n- Bold, italic, code, strikethrough, underline, highlighting\n- Code blocks and blockquotes\n- Clickable links\n\n**Keyboard Shortcuts**\n\n| Shortcut              | Action            |\n| --------------------- | ----------------- |\n| **Navigation**        |                   |\n| `Cmd+N`               | New page          |\n| `Cmd+P`               | Open page picker  |\n| `Cmd+[`               | Back              |\n| `Cmd+]`               | Forward           |\n| `Cmd+Option+F`        | Jump to frontpage |\n| `Cmd+Option+I`        | Open page index   |\n| **Inline Styling**    |                   |\n| `Cmd+B`               | Bold              |\n| `Cmd+I`               | Italic            |\n| `Cmd+U`               | Underline         |\n| `Cmd+Shift+C`         | Inline code       |\n| `Cmd+Shift+H`         | Highlight text    |\n| `Cmd+Shift+X`         | Strikethrough     |\n| `Cmd+K`               | Insert/Edit link  |\n| `Cmd+\\`               | Clear formatting  |\n| **Paragraph Styling** |                   |\n| `Cmd+Option+0`        | Text paragraph    |\n| `Cmd+Option+1`        | Header 1          |\n| `Cmd+Option+2`        | Header 2          |\n| `Cmd+Option+3`        | Header 3          |\n| `Cmd+Shift+5`         | Blockquote        |\n| `Cmd+Shift+6`         | Code block        |\n| `Cmd+Shift+7`         | Numbered list     |\n| `Cmd+Shift+8`         | Bulleted list     |\n| `Cmd+Shift+9`         | Checklist         |\n\n**Auto-Save**\n\n- Changes are saved automatically\n- Status bar shows save status and last save time\n- Creates parent directories as needed\n\n**Link Formats**\n\n- Standard Markdown: `[text](page.md)`\n- Wiki-style: `[[PageName]]`\n- Nested paths: `[[folder/page]]`\n\n**Plugin System**\n\n- Dynamic pages with `!` prefix\n- Built-in `!index` plugin lists all pages\n- Plugin pages are read-only\n- Extensible for custom dynamic content\n\n## Git Integration\n\nPiki works seamlessly with Git for version control:\n\n```bash\ncd ~/.piki\ngit init\ngit add .\ngit commit -m \"Initial wiki\"\n\n# Use piki's git commands\npiki log\npiki run git status\n\n# Or use aliases in .pikirc\npiki sync    # Commit, pull, push\npiki push    # Commit and push\n```\n\n## Platform Support\n\nPiki is fully cross-platform:\n\n| Platform    | CLI | GUI | Notes                           |\n| ----------- | --- | --- | ------------------------------- |\n| **macOS**   | ✅  | ✅  | Native menu bar support         |\n| **Linux**   | ✅  | ✅  | X11 or Wayland required for GUI |\n| **Windows** | ✅  | ✅  | Fully supported                 |\n| **BSD**     | ✅  | ✅  | FreeBSD, OpenBSD, etc.          |\n\n## Architecture\n\nPiki is organized as a Cargo workspace:\n\n- **`core/`** - Shared library (document store, plugins)\n- **`cli/`** - Command-line interface\n- **`gui/`** - FLTK-based graphical interface\n\n## Philosophy\n\n**Local-First**\nYour notes are plain text files on your filesystem. No databases, no proprietary formats, no cloud services.\n\n**Privacy**\nNo telemetry, no tracking, no data leaving your machine. Your personal knowledge stays personal.\n\n**Interoperability**\nMarkdown files work with any editor or tool. Use Piki alongside VS Code, Obsidian, vim, or anything else.\n\n**Simplicity**\nFast startup, minimal dependencies, straightforward workflows. A tool that gets out of your way.\n\n## Contributing\n\nContributions are welcome! Some ideas:\n\n- [ ] Package managers (Homebrew, apt, Chocolatey, AUR)\n- [ ] Full-text search across all pages\n- [ ] Backlinks and page graph\n- [ ] Custom syntax highlighting themes\n- [ ] Mobile companion app\n- [ ] Web server mode (read-only)\n- [ ] Additional plugins (calendar, task list, etc.)\n\nSee the [issues](https://github.com/roblillack/piki/issues) page on GitHub.\n\n## License\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froblillack%2Fpiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froblillack%2Fpiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froblillack%2Fpiki/lists"}