6 stable releases

Uses old Rust 2015

1.4.0 Nov 8, 2017
1.3.0 Sep 22, 2016
1.2.0 Aug 16, 2016
1.1.0 Jun 30, 2016
1.0.2 May 12, 2016

#28 in #snippets

Download history 6/week @ 2024-04-03 59/week @ 2024-07-03 7/week @ 2024-07-10

66 downloads per month

MIT license

31KB
721 lines

Slate

Slate is a snippets manager for your command line.

It helps you to have all those small pieces of code, text, and so on in one place and in your favorite environment: the shell.

Installation

Slate is made with rust, so you will need the latest stable version of it to compile and run the program.

Clone the repository and run cargo install. You can also run cargo build if you want only to play with it:

$ git clone https://github.com/jhbabon/slate.git slate
$ cd slate
$ cargo install

Usage

You can always check all the commands available with the --help option:

$ slate --help
Slate: Manage your snippets from your command line.

Note that Slate will use the file ~/.slate to save
its contents.

Usage:
  slate <command> [<args>...]
  slate [options]

Options:
  -h --help      Show this screen.
  -v --version   Show version.

Commands:
   set     Write a new key and value.
   get     Read a key.
   list    List all keys.
   rename  Rename a key.
   remove  Delete a key.

As you can see, Slate is basically a HashMap, so playing with it is straight forward:

# Basic operations
$ slate set foo bar
$ slate get foo
bar
$ slate list
foo
$ slate remove foo
The key has been removed
$ slate list

# Renaming
$ slate set bar baz
$ slate list
bar

$ slate rename bar foo
The key has been renamed
$ slate list
foo

# Cleaning up
$ slate remove --all
All keys have been removed

It also plays nice with other UNIX tools:

$ cat redis.conf | slate set redis
$ slate get redis
daemonize yes
dbfilename dump.rdb
dir /tmp

$ cd other/project
$ slate get redis > redis.conf
$ cd other/project/v2
$ slate get redis > redis.conf

The ~/.slate file

By default Slate will save all its contents in the file ~/.slate. It is just a plain JSON file for the moment. It is better if you don't touch it and let the program handle it.

Using your own custom file

If you don't want to use the default ~/.slate file or, for example, you want to have a different one per project you can customize the path to the file with the SLATE_FILEPATH env variable:

$ SLATE_FILEPATH=/path/to/the/file/slate.json slate set foo bar
$ SLATE_FILEPATH=/path/to/the/file/slate.json slate list
foo

If you use a tool like direnv you can easily set different slate files per directory/project.

Dependencies

~5MB
~106K SLoC