{"id":13500396,"url":"https://github.com/qownnotes/qc","last_synced_at":"2025-03-29T07:30:50.323Z","repository":{"id":39866128,"uuid":"429855889","full_name":"qownnotes/qc","owner":"qownnotes","description":"QOwnNotes command-line snippet manager.","archived":false,"fork":false,"pushed_at":"2025-03-23T19:37:10.000Z","size":228,"stargazers_count":26,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-23T20:31:20.022Z","etag":null,"topics":["golang","qownnotes","snippets"],"latest_commit_sha":null,"homepage":"https://www.qownnotes.org/getting-started/command-line-snippet-manager.html","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/qownnotes.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}},"created_at":"2021-11-19T16:01:09.000Z","updated_at":"2025-03-23T19:37:13.000Z","dependencies_parsed_at":"2023-12-06T21:23:26.390Z","dependency_job_id":"3fdbe16e-c151-4ac1-be0b-57ad95208fb3","html_url":"https://github.com/qownnotes/qc","commit_stats":{"total_commits":59,"total_committers":2,"mean_commits":29.5,"dds":"0.13559322033898302","last_synced_commit":"3c4c031c33aeeac123df3abc6e1e6da1e269c609"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qownnotes%2Fqc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qownnotes%2Fqc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qownnotes%2Fqc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qownnotes%2Fqc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qownnotes","download_url":"https://codeload.github.com/qownnotes/qc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246155984,"owners_count":20732355,"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","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":["golang","qownnotes","snippets"],"created_at":"2024-07-31T22:00:58.702Z","updated_at":"2025-03-29T07:30:50.059Z","avatar_url":"https://github.com/qownnotes.png","language":"Go","funding_links":[],"categories":["Go","golang"],"sub_categories":[],"readme":"# QOwnNotes command-line snippet manager\n\n[GitHub](https://github.com/qownnotes/qc) |\n[Changelog](https://github.com/qownnotes/qc/blob/main/CHANGELOG.md) |\n[Releases](https://github.com/qownnotes/qc/releases)\n\nYou can use the **QOwnNotes command-line snippet manager** to **execute command snippets** stored\nin **notes** in [QOwnNotes](https://www.qownnotes.org/) from the command line.\n\n![qc](qc.png)\n\nYou can use **notes with a special tag** (`commands` by default) to store **command snippets**, which you can\n**execute from the command-line snippet manager**.\n\n![commands](commands.png)\n\nFor more information on **how to add commands and configuration** please see\n[Command-line Snippet Manager](https://www.qownnotes.org/getting-started/command-line-snippet-manager.html).\n\nThe QOwnNotes command-line snippet manager is based on the wonderful\n[pet CLI Snippet Manager](https://github.com/knqyf263/pet).\n\n## Installation\n\nVisit the [latest release page](https://github.com/qownnotes/qc/releases/latest)\nand download the version you need.\n\nIf you have [jq](https://stedolan.github.io/jq) installed you can also use this snippet\nto download and install for example the latest Linux AMD64 binary to `/usr/local/bin/qc`:\n\n```bash\ncurl https://api.github.com/repos/qownnotes/qc/releases/latest | \\\njq '.assets[] | select(.browser_download_url | endswith(\"_linux_amd64.tar.gz\")) | .browser_download_url' | \\\nxargs curl -Lo /tmp/qc.tar.gz \u0026\u0026 \\\ntar xfz /tmp/qc.tar.gz -C /tmp \u0026\u0026 \\\nrm /tmp/qc.tar.gz \u0026\u0026 \\\nsudo mv /tmp/qc /usr/local/bin/qc \u0026\u0026 \\\n/usr/local/bin/qc version\n```\n\n### macOS / Homebrew\n\nYou can use homebrew on macOS to install qc.\n\n```bash\nbrew install qownnotes/qc/qc\n```\n\nIf you receive an error (`Error: qownnotes/qc/qc 64 already installed`) during `brew upgrade`,\ntry the following command:\n\n```bash\nbrew unlink qc \u0026\u0026 brew uninstall qc\nrm -rf /usr/local/Cellar/qc/64\nbrew install qownnotes/qc/qc\n```\n\n## Dependencies\n\n[fzf](https://github.com/junegunn/fzf) (fuzzy search) or [peco](https://github.com/peco/peco)\n(older, but more likely to be installed by default) need to be installed to search\nfor commands on the command-line.\n\nBy default `fzf` is used for searching, but you can use `peco` by setting it with `qc configure`.\n\nOn some system you might need to set `fzf --ansi` when you use the qc `--color` flag.\nIf you don't want the fuzzy search of fzf, you can use the fzf `--exact` flag.\n\n## Usage\n\n```\nUsage:\nqc [command]\n\nAvailable Commands:\ncompletion  generate the autocompletion script for the specified shell\nconfigure   Edit config file\nexec        Run the selected commands\nhelp        Help about any command\nsearch      Search snippets\nversion     Print the version number\n\nFlags:\n--config string   config file (default is $HOME/.config/qc/config.toml)\n--debug           debug mode\n-h, --help        help for qc\n\nUse \"qc [command] --help\" for more information about a command.\n```\n\n## Configuration\n\nRun `qc configure`.\n\n```toml\n[General]\n  editor = \"vim\"            # your favorite text editor\n  column = 40               # column size for list command\n  selectcmd = \"fzf\"         # selector command for edit command (fzf or peco)\n  sortby = \"\"               # specify how snippets get sorted (recency (default), -recency, description, -description, command, -command, output, -output)\n\n[QOwnNotes]\n  token = \"SECRET\"          # your QOwnNotes API token\n  websocket_port = 22222    # websocket port in QOwnNotes\n```\n\n## Shell completion\n\nYou can generate shell completion code for your shell with `qc completion \u003cshell\u003e`.\n\nFor example for the Fish shell you can use:\n\n```bash\nqc completion fish \u003e ~/.config/fish/completions/qc.fish\n```\n\n## Atuin integration\n\nExecuted commands can be stored in [Atuin](https://atuin.sh/) on execution\nwhen using the `--atuin` flag. They will then show up in the Atuin command history.\n\n```bash\nqc exec --atuin\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqownnotes%2Fqc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqownnotes%2Fqc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqownnotes%2Fqc/lists"}