{"id":42226715,"url":"https://github.com/adrianpk/mnemosyne","last_synced_at":"2026-01-27T02:36:08.934Z","repository":{"id":328218545,"uuid":"1114020695","full_name":"adrianpk/mnemosyne","owner":"adrianpk","description":"A gentle muse for your prose","archived":false,"fork":false,"pushed_at":"2025-12-18T09:24:10.000Z","size":6846,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-21T10:21:56.892Z","etag":null,"topics":["cli","practice","proofreader","rust","tool"],"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/adrianpk.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},"funding":{"github":"adrianpk"}},"created_at":"2025-12-10T19:35:05.000Z","updated_at":"2025-12-18T09:18:01.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/adrianpk/mnemosyne","commit_stats":null,"previous_names":["adrianpk/mnemosyne"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/adrianpk/mnemosyne","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianpk%2Fmnemosyne","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianpk%2Fmnemosyne/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianpk%2Fmnemosyne/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianpk%2Fmnemosyne/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrianpk","download_url":"https://codeload.github.com/adrianpk/mnemosyne/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianpk%2Fmnemosyne/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28796981,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T01:07:07.743Z","status":"online","status_checked_at":"2026-01-27T02:00:07.755Z","response_time":168,"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","practice","proofreader","rust","tool"],"created_at":"2026-01-27T02:36:07.873Z","updated_at":"2026-01-27T02:36:08.922Z","avatar_url":"https://github.com/adrianpk.png","language":"Rust","funding_links":["https://github.com/sponsors/adrianpk"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/img/mnemosyne.png\" alt=\"Mnemosyne\" height=\"120\"\u003e\n\u003c/p\u003e\n\n# Mnemosyne\n\nA terminal-based proofreader that helps refine your texts through a quiet interface.\n\n## What it aims to be\n\n- A TUI tool for working with text documents, paragraph by paragraph\n- An AI-assisted writing environment (left panel: conversation, right panel: document)\n- A simple internal versioning system (no git dependency)\n\n## What it actually is (for now)\n\nA learning project. An excuse to finally give Rust a fair chance, or rather, to let Rust give me one.\n\nThe goal is to build something useful while actually getting the 'kung-fu' of ownership, borrowing, lifetimes, and all those things that tripped me up before. This time with a real project, not abstract exercises.\n\n## Status\n\nMost of the core functionality is implemented now. The interface works, operations respond as they should. Details could use polishing, but it's becoming something you can actually use.\n\n[See it in action](docs/gallery/index.md)\n\n## Installation\n\n### Pre-compiled binaries\n\nPre-compiled binaries will be available in the next few days, after polishing some final details.\n\n**Download the pre-compiled binary for your system:**\n\n1. Go to the [Releases page](https://github.com/adrianpk/mnemosyne/releases)\n2. Download the latest version for your operating system:\n   - **Windows**: `mnemosyne-windows-x86_64.exe`\n   - **macOS (Intel)**: `mnemosyne-macos-x86_64`\n   - **macOS (Apple Silicon)**: `mnemosyne-macos-arm64`\n   - **Linux**: `mnemosyne-linux-x86_64`\n3. Move the file to a convenient location\n4. On macOS/Linux, make it executable:\n   ```bash\n   chmod +x mnemosyne-macos-x86_64  # or the Linux version\n   ```\n5. Run it:\n   - **Windows**: Double-click `mnemosyne-windows-x86_64.exe` or run from terminal\n   - **macOS/Linux**: Open terminal and run `./mnemosyne-macos-x86_64 your-document.txt`\n\n### For developers\n\nIf you have Rust installed, you can build from source:\n\n```bash\ngit clone \u003crepository-url\u003e\ncd mnemosyne\ncargo build --release\n./target/release/mnemosyne your-document.txt\n```\n\n## Configuration\n\n### Setting your OpenAI API Key\n\n**Recommended: Use the app's Settings (F11)**\n\nRun the app and press `F11` to open Settings. Enter your API key and press `Ctrl+S` to save. The key will be stored securely at `~/.config/mnemosyne/config.toml` with permissions 600 (owner read/write only).\n\n**Alternative methods:**\n\nIf you prefer to configure manually:\n\n*Option 1: Edit config file directly*\n```bash\nmkdir -p ~/.config/mnemosyne\ncp config.example.toml ~/.config/mnemosyne/config.toml\nnano ~/.config/mnemosyne/config.toml  # Add your API key\n```\n\n*Option 2: Environment variable*\n```bash\nexport OPENAI_MNEMOSYNE_API_KEY=\"sk-your-key\"\n```\n\nPriority order: config file \u003e `OPENAI_MNEMOSYNE_API_KEY` \u003e `OPENAI_API_KEY`\n\n## Usage\n\n```bash\ncargo run -- path/to/document.txt\n```\n\nFor detailed documentation on all features and operations, see the [Usage Guide](docs/usage-guide.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianpk%2Fmnemosyne","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrianpk%2Fmnemosyne","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianpk%2Fmnemosyne/lists"}