Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qownnotes/qc
QOwnNotes command-line snippet manager.
https://github.com/qownnotes/qc
golang qownnotes snippets
Last synced: 11 days ago
JSON representation
QOwnNotes command-line snippet manager.
- Host: GitHub
- URL: https://github.com/qownnotes/qc
- Owner: qownnotes
- License: mit
- Created: 2021-11-19T16:01:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T18:54:50.000Z (5 months ago)
- Last Synced: 2024-08-01T22:53:08.621Z (3 months ago)
- Topics: golang, qownnotes, snippets
- Language: Go
- Homepage: https://www.qownnotes.org/getting-started/command-line-snippet-manager.html
- Size: 217 KB
- Stars: 23
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# QOwnNotes command-line snippet manager
[GitHub](https://github.com/qownnotes/qc) |
[Changelog](https://github.com/qownnotes/qc/blob/main/CHANGELOG.md) |
[Releases](https://github.com/qownnotes/qc/releases)
You can use the **QOwnNotes command-line snippet manager** to **execute command snippets** stored
in **notes** in [QOwnNotes](https://www.qownnotes.org/) from the command line.
You can use **notes with a special tag** (`commands` by default) to store **command snippets**, which you can
**execute from the command-line snippet manager**.
For more information on **how to add commands and configuration** please see
[Command-line Snippet Manager](https://www.qownnotes.org/getting-started/command-line-snippet-manager.html).
The QOwnNotes command-line snippet manager is based on the wonderful
[pet CLI Snippet Manager](https://github.com/knqyf263/pet).
## Installation
Visit the [latest release page](https://github.com/qownnotes/qc/releases/latest)
and download the version you need.
If you have [jq](https://stedolan.github.io/jq) installed you can also use this snippet
to download and install for example the latest Linux AMD64 binary to `/usr/local/bin/qc`:
```bash
curl https://api.github.com/repos/qownnotes/qc/releases/latest | \
jq '.assets[] | select(.browser_download_url | endswith("_linux_amd64.tar.gz")) | .browser_download_url' | \
xargs curl -Lo /tmp/qc.tar.gz && \
tar xfz /tmp/qc.tar.gz -C /tmp && \
rm /tmp/qc.tar.gz && \
sudo mv /tmp/qc /usr/local/bin/qc && \
/usr/local/bin/qc version
```
### macOS / Homebrew
You can use homebrew on macOS to install qc.
```bash
brew install qownnotes/qc/qc
```
If you receive an error (`Error: qownnotes/qc/qc 64 already installed`) during `brew upgrade`,
try the following command:
```bash
brew unlink qc && brew uninstall qc
rm -rf /usr/local/Cellar/qc/64
brew install qownnotes/qc/qc
```
## Dependencies
[fzf](https://github.com/junegunn/fzf) (fuzzy search) or [peco](https://github.com/peco/peco)
(older, but more likely to be installed by default) need to be installed to search
for commands on the command-line.
By default `fzf` is used for searching, but you can use `peco` by setting it with `qc configure`.
On some system you might need to set `fzf --ansi` when you use the qc `--color` flag.
If you don't want the fuzzy search of fzf, you can use the fzf `--exact` flag.
## Usage
```
Usage:
qc [command]
Available Commands:
completion generate the autocompletion script for the specified shell
configure Edit config file
exec Run the selected commands
help Help about any command
search Search snippets
version Print the version number
Flags:
--config string config file (default is $HOME/.config/qc/config.toml)
--debug debug mode
-h, --help help for qc
Use "qc [command] --help" for more information about a command.
```
## Configuration
Run `qc configure`.
```toml
[General]
editor = "vim" # your favorite text editor
column = 40 # column size for list command
selectcmd = "fzf" # selector command for edit command (fzf or peco)
sortby = "" # specify how snippets get sorted (recency (default), -recency, description, -description, command, -command, output, -output)
[QOwnNotes]
token = "SECRET" # your QOwnNotes API token
websocket_port = 22222 # websocket port in QOwnNotes
```
## Shell completion
You can generate shell completion code for your shell with `qc completion `.
For example for the Fish shell you can use:
```bash
qc completion fish > ~/.config/fish/completions/qc.fish
```
## Atuin integration
Executed commands can be stored in [Atuin](https://atuin.sh/) on execution
when using the `--atuin` flag. They will then show up in the Atuin command history.
```bash
qc exec --atuin
```