GithubHelp home page GithubHelp logo

dbalan / pipet Goto Github PK

View Code? Open in Web Editor NEW
20.0 3.0 0.0 56 KB

Personal snippet manager, store bits of text.

License: BSD 3-Clause "New" or "Revised" License

Go 100.00%
go snippet-manager snippets

pipet's Introduction

Pipet: snippet manager

CircleCI

Pipet is a set of commands to store and retrieve snippets of text. Depends on fzf for search.

Installation

There are multiple ways to get pipet.

  1. As a go package (provided you have a working go setup)
go get github.com/dbalan/pipet
cd $GOPATH/src/github.com/dbalan/pipet/
go build
go install # installs to $GOPATH/bin
  1. As a binary release see: https://github.com/dbalan/pipet/releases. On *nix you need to set executable permission (chmod +x pipet)

Configuration

Pipet looks for config file .pipet.yaml in the home directory. pipet init command can generate a new config.

Sample config

document_dir: "<directory-where-files-are-stored>" # default is ~/snippets
editor_binary: "absolute path to editor you want to use" # default is $EDITOR environment variable

Usage

asciicast

Store and sprinkle code snippets

Usage:
  pipet [command]

Available Commands:
  delete      Remove snippet from storage (this is irreversible!)
  edit        edit snippet data
  help        Help about any command
  init        Configure pipet
  list        list all snippets
  new         Creates a new snippet and opens editor to edit content
  show        display the snippet

Flags:
      --config string   config file (default is $HOME/.pipet.yaml)
  -h, --help            help for pipet
  -t, --toggle          Help message for toggle

Use "pipet [command] --help" for more information about a command.

TODO

  • Tests, would like more tests.
  • Add an archive flag in place of delete (?)

Hacking

See CONTRIBUTING.md

Versioning

Follows semantic versioning.

Thanks

Pipet takes a heavy inspiration from pet and other projects.

pipet's People

Contributors

dbalan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

pipet's Issues

`new` should ask for a title.

Even though we can pass title with a flag for new, if its unset, we should ask for a title befire creating the file

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.