{"id":28230851,"url":"https://github.com/zhd4/notesr-cli","last_synced_at":"2026-02-27T11:26:55.847Z","repository":{"id":281847028,"uuid":"875668421","full_name":"zHd4/NoteSR-Cli","owner":"zHd4","description":"NoteSR-Cli can process exports from NoteSR","archived":false,"fork":false,"pushed_at":"2026-02-23T17:40:43.000Z","size":1586,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-23T17:57:13.181Z","etag":null,"topics":["aes","aes-256","cli","encryption","notesr","sqlite"],"latest_commit_sha":null,"homepage":"","language":"Java","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/zHd4.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2024-10-20T15:30:36.000Z","updated_at":"2026-02-23T10:09:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"46c7a18a-7fb9-489e-9a94-3996e904d76f","html_url":"https://github.com/zHd4/NoteSR-Cli","commit_stats":null,"previous_names":["zhd4/notesr-cli"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/zHd4/NoteSR-Cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zHd4%2FNoteSR-Cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zHd4%2FNoteSR-Cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zHd4%2FNoteSR-Cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zHd4%2FNoteSR-Cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zHd4","download_url":"https://codeload.github.com/zHd4/NoteSR-Cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zHd4%2FNoteSR-Cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29892081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T09:48:51.284Z","status":"ssl_error","status_checked_at":"2026-02-27T09:48:43.992Z","response_time":57,"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":["aes","aes-256","cli","encryption","notesr","sqlite"],"created_at":"2025-05-18T17:16:25.742Z","updated_at":"2026-02-27T11:26:55.808Z","avatar_url":"https://github.com/zHd4.png","language":"Java","readme":"# NoteSR-Cli\n\n**NoteSR-Cli** is a cross-platform command-line utility designed to process exports from [NoteSR](https://github.com/zHd4/NoteSR).\n\n[![GitHub release](https://img.shields.io/github/v/release/zHd4/NoteSR-Cli)](https://github.com/zHd4/NoteSR-Cli/releases)\n[![Java CI](https://github.com/zHd4/NoteSR-Cli/actions/workflows/ci.yml/badge.svg)](https://github.com/zHd4/NoteSR-Cli/actions/workflows/ci.yml)\n[![Maintainability](https://qlty.sh/gh/zHd4/projects/NoteSR-Cli/maintainability.svg)](https://qlty.sh/gh/zHd4/projects/NoteSR-Cli)\n[![Code Coverage](https://qlty.sh/gh/zHd4/projects/NoteSR-Cli/coverage.svg)](https://qlty.sh/gh/zHd4/projects/NoteSR-Cli)\n\n## 🚀 Quick Start\n\n```bash\ngit clone https://github.com/zHd4/NoteSR-Cli.git\ncd NoteSR-Cli\n./gradlew build\n\n# After build\ncd build/notesr-cli/bin\n./notesr-cli --help\n```\n\nOr download the [latest version](https://github.com/zHd4/NoteSR-Cli/releases/tag/v1.1.2) from the [Releases page](https://github.com/zHd4/NoteSR-Cli/releases).\n\n---\n\n## 🎯 What It Does\n\nNoteSR-CLI allows you to:\n\n* 🔓 Decrypt `.notesr.bak` backups from NoteSR (AES-256 encrypted)\n* 🧠 Read notes and list files directly from the SQLite database\n* 📦 Compile a SQLite backup into a valid `.notesr.bak` file\n* 📌 Attach and extract files from notes\n* 🔍 Inspect and manage your encrypted notes via terminal\n\n---\n\n## ⚙️ Commands Overview\n\n### 🟢 General Help\n\n```bash\n./notesr-cli --help\n```\n\n---\n\n### 🔓 `decrypt`\n\nDecrypts a NoteSR `.notesr.bak` file into a readable SQLite database.\n\n```bash\n./notesr-cli decrypt /path/to/backup.notesr.bak /path/to/crypto_key.txt -o output.notesr.db\n```\n\n* `file_path` — path to the encrypted `.notesr.bak` file\n* `key_path` — path to the AES key file (text format)\n* `-o` — optional output path (defaults to `bak_file_name.notesr.db`)\n\n---\n\n### 📦 `compile`\n\nCompiles a SQLite NoteSR backup into an encrypted `.notesr.bak` file.\n\n```bash\n./notesr-cli compile notes.notesr.db crypto_key.txt -o backup.notesr.bak\n```\n\n* `db_path` — SQLite database file\n* `key_path` — AES key file (text)\n* `-o` — output `.notesr.bak` file\n\n---\n\n### 📄 `list-notes`\n\nLists all notes from the decrypted SQLite database.\n\n```bash\n./notesr-cli list-notes notes.notesr.db\n```\n\n---\n\n### 🧒 `read-note`\n\nDisplays the full content of a specific note.\n\n```bash\n./notesr-cli read-note notes.notesr.db NOTE_ID\n```\n\n---\n\n### 📁 `list-files`\n\nLists all files attached to a specific note.\n\n```bash\n./notesr-cli list-files notes.notesr.db NOTE_ID\n```\n\n---\n\n### 📥 `get-file`\n\nExtracts a file attached to a note and saves it to disk.\n\n```bash\n./notesr-cli get-file notes.notesr.db NOTE_ID FILE_ID -o ./output_dir\n```\n\n* `NOTE_ID` — ID of the note\n* `FILE_ID` — ID of the file attachment\n* `-o` — output file or directory path (optional)\n\n---\n\n### 📤 `put-file`\n\nAttaches a local file to a specific note.\n\n```bash\n./notesr-cli put-file notes.notesr.db NOTE_ID /path/to/local/file.jpg\n```\n\n---\n\n## 🧪 Run Tests\n\n```bash\n./gradlew test\n```\n\n---\n\n## ⚖️ License\n[MIT](https://raw.githubusercontent.com/zHd4/NoteSR-Cli/refs/heads/master/LICENSE)\n\n---\n\n## 📜 Requirements\n\n* Java 21+\n* Gradle (optional — project includes wrapper)\n\n---\n\n## 📌 Project Details\n\n* Language: **Java**\n* CLI Framework: **Picocli**\n* DB Layer: **JDBI** (SQLite)\n* Crypto: **AES-256**, compatible with NoteSR Android\n* Logging: **SLF4J + SimpleLogger**\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhd4%2Fnotesr-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhd4%2Fnotesr-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhd4%2Fnotesr-cli/lists"}