{"id":31131805,"url":"https://github.com/qrxnz/gopuntes","last_synced_at":"2025-09-18T04:38:37.980Z","repository":{"id":313645252,"uuid":"1048333241","full_name":"qrxnz/gopuntes","owner":"qrxnz","description":"A flexible note-browsing tool  💖🇪🇸","archived":false,"fork":false,"pushed_at":"2025-09-15T15:39:16.000Z","size":55,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-15T17:39:58.500Z","etag":null,"topics":["bubbletea","charm","charmbracelet","cli","cli-app","go","go-cli","golang","linux","macos","notebook","notes","notes-app"],"latest_commit_sha":null,"homepage":"","language":"Go","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/qrxnz.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":"2025-09-01T09:30:42.000Z","updated_at":"2025-09-15T15:39:20.000Z","dependencies_parsed_at":"2025-09-07T15:29:11.967Z","dependency_job_id":"4ba52a88-439d-41e9-86e5-cf67e8d39673","html_url":"https://github.com/qrxnz/gopuntes","commit_stats":null,"previous_names":["qrxnz/gopuntes"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/qrxnz/gopuntes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qrxnz%2Fgopuntes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qrxnz%2Fgopuntes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qrxnz%2Fgopuntes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qrxnz%2Fgopuntes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qrxnz","download_url":"https://codeload.github.com/qrxnz/gopuntes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qrxnz%2Fgopuntes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275711115,"owners_count":25514200,"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-18T02:00:09.552Z","response_time":77,"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":["bubbletea","charm","charmbracelet","cli","cli-app","go","go-cli","golang","linux","macos","notebook","notes","notes-app"],"created_at":"2025-09-18T04:38:36.229Z","updated_at":"2025-09-18T04:38:37.974Z","avatar_url":"https://github.com/qrxnz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gopuntes\n\nhttps://github.com/user-attachments/assets/ffad79b0-3d63-4247-9ed9-c138204fd2b2\n\n\u003e A flexible note-browsing tool 💖🇪🇸\n\n**gopuntes** is a terminal-based application for browsing and viewing your local notes. It provides a fast and simple TUI (Text User Interface) to navigate through your Markdown and PDF files stored in a designated directory.\n\nBuilt with Go \u0026 [Bubble Tea](https://github.com/charmbracelet/bubbletea) framework.\n\n## 🧰 Features\n\n-   **Terminal-based UI**: Browse your notes without leaving the terminal.\n-   **Multi-format Support**: Natively renders Markdown (`.md`) files and opens PDF (`.pdf`) files in your system's default viewer.\n-   **Simple Setup**: On first run, `gopuntes` will prompt you to set the path to your notes directory.\n-   **Fuzzy Search**: Quickly filter and find the note you're looking for.\n-   **Cross-Platform**: Works on macOS \u0026 Linux.\n\n## 📦 Installation\n\n### From Source\n\nEnsure you have a working Go environment (Go 1.21+ is recommended).\n\n```sh\ngo install github.com/gopuntes@latest\n```\n\nor\n\n```sh\ngit clone https://github.com/qrxnz/gopuntes.git \u0026\u0026 \\\ncd gopuntes \u0026\u0026 \\\ngo build .\n```\n\nAlternatively, if you have `go-task` installed, you can simply run:\n\n```sh\ntask build\n```\n\n### Using Nix ❄️\n\n-   Try it without installing:\n\n```sh\nnix run github:qrxnz/gopuntes\n```\n\n-   Installation:\n\nAdd input in your flake like:\n\n```nix\n{\n inputs = {\n   gopuntes= {\n     url = \"github:qrxnz/gopuntes\";\n     inputs.nixpkgs.follows = \"nixpkgs\";\n   };\n };\n}\n```\n\nWith the input added you can reference it directly:\n\n```nix\n{ inputs, system, ... }:\n{\n  # NixOS\n  environment.systemPackages = [ inputs.gopuntes.packages.${pkgs.system}.default ];\n  # home-manager\n  home.packages = [ inputs.gopuntes.packages.${pkgs.system}.default ];\n}\n```\n\nor\n\nYou can install this package imperatively with the following command:\n\n```nix\nnix profile install github:qrxnz/gopuntes\n```\n\n### From Releases\n\nPre-compiled binaries for various operating systems are available on the [GitHub Releases](https://github.com/qrxnz/gopuntes/releases) page. Download the appropriate archive for your system, extract it, and place the `gopuntes` binary in your `PATH`.\n\n## 📖 Usage\n\nSimply run the application from your terminal:\n\n```sh\ngopuntes\n```\n\nOn the first launch, you will be prompted to enter the absolute path to the directory where your notes are stored. This path is saved in `~/.config/gopuntes/config.toml`.\n\n### Keybindings\n\n-   **Arrow Keys** (`↑`/`↓`): Navigate the list of notes.\n-   **Enter**: View the selected note. (Renders Markdown inside the TUI, opens PDFs externally).\n-   **`/`**: Start filtering/searching.\n-   **`q` / `esc`**: Quit the note view or the filter view.\n-   **`Ctrl+C`**: Exit the application.\n\n## 👨🏻‍💻 Development\n\nThis project uses [Nix](https://nixos.org/) with flakes and [direnv](https://direnv.net/) to provide a reproducible development environment.\n\n1.  **Clone the repository:**\n\n    ```sh\n    git clone https://github.com/qrxnz/gopuntes.git\n    cd gopuntes\n    ```\n\n2.  **Activate the environment:**\n    If you have Nix and direnv installed, the environment should be activated automatically when you enter the directory. If not, run:\n\n    ```sh\n    direnv allow\n    ```\n\n3.  **Available Commands:**\n    This project uses `go-task` as a command runner. Here are the most common commands:\n\n    -   `task build`: Build a production binary.\n    -   `task test`: Run unit tests.\n    -   `task lint`: Run the linter and fix issues.\n\n## 🗒️ Credits\n\n### 🎨 Inspiration\n\nI was inspired by:\n\n-   [charmbracelet/glow](https://github.com/charmbracelet/glow)\n\n## 📜 License\n\nThis project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqrxnz%2Fgopuntes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqrxnz%2Fgopuntes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqrxnz%2Fgopuntes/lists"}