{"id":26667417,"url":"https://github.com/deepanchal/dnote-tui","last_synced_at":"2025-09-12T00:39:33.571Z","repository":{"id":189401089,"uuid":"664076835","full_name":"deepanchal/dnote-tui","owner":"deepanchal","description":"Dnote TUI with ratatui","archived":false,"fork":false,"pushed_at":"2025-09-02T21:08:40.000Z","size":3795,"stargazers_count":26,"open_issues_count":24,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-10T13:26:23.830Z","etag":null,"topics":["cli","dnote","ratatui","rust","tui"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/dnote-tui","language":"Rust","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/deepanchal.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-07-08T21:12:12.000Z","updated_at":"2025-08-15T15:22:27.000Z","dependencies_parsed_at":"2023-08-19T21:21:12.113Z","dependency_job_id":"4712565a-d768-48b5-97f7-79c5c6471533","html_url":"https://github.com/deepanchal/dnote-tui","commit_stats":null,"previous_names":["deepanchal/dnote-tui"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/deepanchal/dnote-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepanchal%2Fdnote-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepanchal%2Fdnote-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepanchal%2Fdnote-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepanchal%2Fdnote-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepanchal","download_url":"https://codeload.github.com/deepanchal/dnote-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepanchal%2Fdnote-tui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274732460,"owners_count":25339345,"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-09-11T02:00:13.660Z","response_time":74,"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","dnote","ratatui","rust","tui"],"created_at":"2025-03-25T19:37:19.771Z","updated_at":"2025-09-12T00:39:33.530Z","avatar_url":"https://github.com/deepanchal.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n--\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- \u003ca href=\"https://github.com/deepanchal/dnote-tui\"\u003e --\u003e\n  \u003c!--   \u003cimg src=\"images/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e --\u003e\n  \u003c!-- \u003c/a\u003e --\u003e\n\n\u003ch3 align=\"center\"\u003eDnote TUI\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    TUI for dnote (https://www.getdnote.com/)\n    \u003cbr /\u003e\n    \u003ca href=\"https://docs.rs/dnote-tui\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/deepanchal/dnote-tui/issues/new?assignees=\u0026labels=bug\u0026projects=\u0026template=bug_report.md\u0026title=Bug\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/deepanchal/dnote-tui/issues/new?assignees=\u0026labels=\u0026projects=\u0026template=feature_request.md\u0026title=Feature\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## 🌟 About The Project\n\nA TUI (Terminal User Interface) for [`dnote`](https://www.getdnote.com/).\n\n![Demo](./.github/static/demo.gif)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### 🏗️ Built With\n\n- [`rust`](https://www.rust-lang.org/)\n- [`ratatui`](https://github.com/ratatui-org/ratatui)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 🚀 Getting Started\n\nThis is an example of how you may give instructions on setting up your project locally.\nTo get a local copy up and running follow these simple example steps.\n\n### 🛠️ Prerequisites\n\n1. Install rust: https://www.rust-lang.org/\n2. Install dnote: https://github.com/dnote/dnote#installation\n\n### 📥 Installing\n\n#### Direct download\n\nYou can download the `tar.xz` file matching your operating system from the\n[releases page](https://github.com/deepanchal/dnote-tui/releases), extract it and execute the `dnote-tui`\nbinary.\n\n#### Cargo\n\n```bash\ncargo install dnote-tui\n```\n\nIf you wish to install from the main branch directly, use\n\n```bash\ncargo install --git https://github.com/deepanchal/dnote-tui\n```\n\nOnce it's installed, simply run\n\n```bash\ndnote-tui\n```\n\nI will offer additional installation methods once the project reaches a more stable state.\n\n### 🏃 Running project locally\n\n1. Clone the repo.\n\n```bash\ngit clone https://github.com/deepanchal/dnote-tui.git\n```\n\n2. cd into repo.\n\n```bash\ncd dnote-tui\n```\n\n3. Run tui\n\n```sh\ncargo run\n```\n\n### 🐳 Try with Docker\n\nGet started with dnote-tui quickly using Docker! This setup comes with pre-loaded test data so you can dive right into exploring the TUI features.\n\n1. Clone the repository and navigate to the project directory\n\n```bash\ngit clone https://github.com/deepanchal/dnote-tui.git\ncd dnote-tui\n```\n\n2. To build the Docker image and run the dnote-tui container using Docker Compose, execute the following command:\n\n```bash\ndocker compose run --rm dnote-tui\n```\n\nOr if you prefer to use Docker directly without Docker Compose, you can follow these steps:\n\n```bash\n# Build the docker image\ndocker build --build-arg RUST_VERSION=1.76.0 --build-arg DNOTE_VERSION=0.15.1 -t dnote-tui .\n# Run the docker container\ndocker run --rm -it dnote-tui\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## 📝 Usage\n\n### 🏃 Run\n\n```sh\ncargo run\n```\n\n### 🏗️ Build\n\n```sh\ncargo build\n```\n\n### 🧪 Run Tests\n\n```sh\ncargo test\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## 🎯 Roadmap\n\n- [x] Show basic TUI with three sections (Books, Pages, \u0026 Content)\n- [x] Create a dnote client\n  - [x] Parse output from dnote cli to structs used by dnote client\n  - [x] Add methods to perform write operations with dnote cli in dnote client\n- [ ] Features\n  - [x] Read Operations\n    - [x] Read books from dnote cli into tui\n    - [x] Read pages from dnote cli into tui\n    - [x] Read pages content from dnote cli into tui\n    - [x] Show truncated pages content beside page id in pages section\n  - [ ] Write Operations\n    - [x] Create a new book with page [#19](https://github.com/deepanchal/dnote-tui/issues/19)\n    - [x] Edit a page's content [#37](https://github.com/deepanchal/dnote-tui/issues/37)\n    - [x] Add new page to a book [#49](https://github.com/deepanchal/dnote-tui/issues/49)\n    - [ ] Move page to another book [#60](https://github.com/deepanchal/dnote-tui/issues/60)\n    - [x] Delete a book's page [#51](https://github.com/deepanchal/dnote-tui/issues/51)\n    - [x] Delete a book and all its pages [#52](https://github.com/deepanchal/dnote-tui/issues/52)\n    - [x] Rename book with popup input field [#59](https://github.com/deepanchal/dnote-tui/issues/59)\n  - [ ] Search and Navigation\n    - [ ] Find note within a book [#61](https://github.com/deepanchal/dnote-tui/issues/61)\n    - [ ] Global note search [#47](https://github.com/deepanchal/dnote-tui/issues/47)\n    - [ ] Make page content scrollable [#54](https://github.com/deepanchal/dnote-tui/issues/54)\n  - [ ] Misc (Nice to have)\n    - [ ] Allow note syncing with dnote server [#50](https://github.com/deepanchal/dnote-tui/issues/50)\n    - [x] Parse keybindings for active mode from current config file and show on footer [#64](https://github.com/deepanchal/dnote-tui/issues/64)\n    - [ ] Add ASCII art in header pane [#57](https://github.com/deepanchal/dnote-tui/issues/57)\n    - [ ] Show command log pane to show user what commands are being run just like lazygit [#63](https://github.com/deepanchal/dnote-tui/issues/63)\n    - [ ] Render note's markdown content with glow and make it toggleable [#53](https://github.com/deepanchal/dnote-tui/issues/53)\n\nSee the [open issues](https://github.com/deepanchal/dnote-tui/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 🤝 Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feat/amazing-feature`)\n3. Commit your Changes (`git commit -m 'feat: add some amazing-feature'`)\n4. Push to the Branch (`git push origin feat/amazing-feature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## 📄 License\n\nDistributed under the MIT License. See [`LICENSE`](LICENSE) for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/deepanchal/dnote-tui.svg?style=for-the-badge\n[contributors-url]: https://github.com/deepanchal/dnote-tui/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/deepanchal/dnote-tui.svg?style=for-the-badge\n[forks-url]: https://github.com/deepanchal/dnote-tui/network/members\n[stars-shield]: https://img.shields.io/github/stars/deepanchal/dnote-tui.svg?style=for-the-badge\n[stars-url]: https://github.com/deepanchal/dnote-tui/stargazers\n[issues-shield]: https://img.shields.io/github/issues/deepanchal/dnote-tui.svg?style=for-the-badge\n[issues-url]: https://github.com/deepanchal/dnote-tui/issues\n[license-shield]: https://img.shields.io/github/license/deepanchal/dnote-tui.svg?style=for-the-badge\n[license-url]: https://github.com/deepanchal/dnote-tui/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepanchal%2Fdnote-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepanchal%2Fdnote-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepanchal%2Fdnote-tui/lists"}