Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mchmarny/snip
CLI to manage your snippets
https://github.com/mchmarny/snip
cli productivity reporting snippets
Last synced: about 10 hours ago
JSON representation
CLI to manage your snippets
- Host: GitHub
- URL: https://github.com/mchmarny/snip
- Owner: mchmarny
- License: apache-2.0
- Created: 2019-09-28T14:47:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T18:10:55.000Z (almost 2 years ago)
- Last Synced: 2024-12-31T22:42:52.239Z (about 2 months ago)
- Topics: cli, productivity, reporting, snippets
- Language: Go
- Homepage:
- Size: 13.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# snip
In most companies people set objectives and define some kind of results that will indicate progress towards achieve those objectives (this process is often referred to as [OKRs](https://en.wikipedia.org/wiki/OKR)). Most of the time, people working on these key results will provided periodic reports (snippets), on their activities towards each objective. This utility is meant to simplify the recording and reporting of these "snippets".
> Switching context is expensive. snip follows the [Howardism principle](http://www.howardism.org/Taoism/Do_Without_Doing.html), "Do Without Doing" to help you record your snippets as fast as posable and get back to what you were doing
## Usage
The `snip` CLI can be used from either commandline, or any other workflow utility that is able to integrate your commandline, like [Alfred](https://www.alfredapp.com/).
### Recording Snippets
#### Commandline
To record snippet from commandline you can just use plain text like this:
```shell
snip add Met with @john from @bigco regarding project Apollo ^scale
```
#### Alfred
Productivity tools like Alfred will automatically wire the `snip` activity so all you'll have to do is:
> Check my [Alfred snip workflow](https://github.com/mchmarny/snip/releases/download/v0.5.1/snip.alfredworkflow)
### Snippet Data
Whichever way you enter your snippets, `snip` will automatically parse the plain text into few key attributes. For example, the above commandline will be recognized as:
* `Met with @john from @bigco regarding project Apollo` as the snippet
* `@bigco` and `@bigco` as the contexts of the above snippet
* `^scale` as the objective to which this activity is aiming to achieve
> context and objective are optional
### Reporting
To generate report from the captured snippets simply provide the number of weeks you want to go back:
```shell
snip list -w 1
```
This will print your snippets to console for the current week (`--week-offset` or its shorter version `-w`) indicate the number of weeks in the past (starting with Sunday).
If you want to output to markdown simplify append the file path (`--output` or `-o`)
```shell
snip list -w 1 -o ./snippets.md
```
The result will look something like this:
```shell
# Snippets Since: 2019-09-22
## scale
* 2019-09-28 - Met with @john from @bigco re project Apollo
* 2019-09-29 - did this and that with @person1 in @place1
## new-product
* 2019-09-26 - wrote a document proposal for @July
```
> Snippets are stored in your home directory (e.g. on Mac: `~/.snip/snip.db`).
## Install
On Max and Linux you can install `snip` with [Homebrew](https://brew.sh/):
```shell
brew tap mchmarny/snip
brew install mchmarny/snip/snip
```
All new release will be automatically picked up with `brew upgrade`.
`snip` also provides pre-build releases for Mac, Linux, and Windows for both, AMD and ARM. See [releases](https://github.com/mchmarny/snip/releases) to download the supported distributable for your platform/architecture combination.
Once installed, you can aldo install the [Alfred](https://www.alfredapp.com/) action that wraps snip [here](https://github.com/mchmarny/snip/releases/download/v0.5.1/snip.alfredworkflow)
Alternatively, you can build your own version, see [BUILD.md](./BUILD.md) for details.
## Disclaimer
This is my personal project and it does not represent my employer. I take no responsibility for issues caused by this code. I do my best to ensure that everything works, but if something goes wrong, my apologies is all you will get.
## License
This software is released under the [Apache v2 License](./LICENSE)