Skip to main content

An advanced snippet manager for the command-line.

Project description

snippet

snippet allows you to create, view and use snippets on the command-line.

Usage

Snippet-Cli Preview

# Add a new snippet to the database
$ snippet -e archive/extract-tgz -f 'tar -xzvf <archive>'

# Edit a snippet (will open vim)
$ snippet -e archive/extract-tgz

# Search and use a snippet which include the term "extract" (will open fzf)
$ snippet -t extract

# Fill snippet with a value
$ snippet -t archive/extract-tgz /path/to/foo.tar.gz
tar -xvf /path/to/foo.tar.gz

# Fill snippet with multiple values
$ snippet -t archive/extract-tgz /path/to/foo.tar.gz /path/to/bar.tar.gz
tar -xvf /path/to/foo.tar.gz
tar -xvf /path/to/bar.tar.gz

# Fill snippet with multiple values while using repeatable placeholders (e.g. <file...>)
$ snippet -f "tar -czvf <archive> <file...>" /path/to/foo.tar file=foo bar
tar -czvf /path/to/foo.tar.gz foo bar

# Using presets (e.g. '<datetime>' to include current datetime)
$ snippet -f "tar -czvf '<datetime>.tar.gz' <file...>" file=foo bar
tar -czvf 20770413000000.tar.gz foo bar

# Import values from file
$ cat <<EOF > files.txt
foo
bar
EOF
$ snippet -f "tar -czvf '<datetime>.tar.gz' <file...>" file:files.txt
tar -czvf 20770413000000.tar.gz foo bar

# Using optionals
$ snippet -f "python3 -m http.server[ --bind<lhost>][ <lport>]"
python3 -m http.server
$ snippet -f "python3 -m http.server[ --bind<lhost>][ <lport>]" lport=4444
python3 -m http.server 4444

# Using defaults
$ snippet -f "python3 -m http.server[ --bind<lhost>] <lport=8000>"
python3 -m http.server 8000

# Using codecs
$ snippet -f "tar -czvf <archive|squote> <file:squote...>" /path/to/foo.tar file=foo bar
tar -czvf '/path/to/foo.tar.gz' 'foo' 'bar'

Setup

pip3 install snippet-cli

To enable bash-completion you might add following line to your .bashrc:

eval "$(register-python-argcomplete3 snippet)"

Advanced usage

  1. Assigning data to placeholders
    1. Using positional arguments
    2. Using environment variables
    3. Using presets
  2. Using string formats
    1. Using on-the-fly transformation
    2. Using input from a pipe
    3. Using templates
    4. Using defaults
    5. Using optionals
    6. Using codecs
  3. Executing commands
  4. See also

Assigning data to placeholders

To assign data to a placeholder you have several options:

Using positional arguments

The most straight forward way of assigning data to a placeholder is to use positional arguments:

$ snippet -f "echo 'hello <arg1>';" snippet
echo 'hello snippet';

To assign multiple values to a specific placeholder you need to explicitly declare the placeholder to which the value should be assigned to:

$ snippet -f "echo '<arg1> <arg2>';" hello arg2=snippet world
echo 'hello snippet';
echo 'hello world';

Using input files

Values can be directly imported from a file:

$ cat <<EOF > input.txt
world
universe
EOF
$ snippet -f "echo 'hello <arg1>';" arg1:input.txt
echo 'hello world';
echo 'hello universe';

Using environment variables

snippet evaluates environment variables and assigns data to any unset placeholder. To avoid running into conflict with other environment variables snippet only evaluates lower-case variable names:

$ export arg1=snippet
$ snippet -f "echo 'hello <arg1>';"
echo 'hello snippet';

To assign multiple values to a placeholder following syntax must be used:

$ export arg1="\('snippet' 'world'\)"
$ snippet -f "echo 'hello <arg1>';"
echo 'hello snippet';
echo 'hello world';

Note that positional arguments may override the evaluation of environment variables:

$ export arg1=snippet
$ snippet -f "echo 'hello <arg1>';" world
echo 'hello world';

Using presets

snippet ships with a customizable set of preset placeholders which can be directly used in your format string (see .snippet/snippet_profile.py for more information). Preset placeholders may have constant
but also dynamically generated values assigned to them:

$ snippet -f "echo '<datetime>';" 
echo '20200322034102';

Using string formats

To use string formats you have several options:

Using the --format-string argument

If you read the previous section you already know the -f | --format-string argument:

$ snippet -f "echo 'hello snippet';"
echo 'hello snippet';

Using input from a pipe

Another option to set the string format is by using a pipe:

$ echo "echo 'hello snippet'" | snippet
echo 'hello snippet';

Using templates

snippet allows you to import format strings from a file by using the -t | --template argument.

There are two ways of creating a template:

  1. Create a file with the .snippet extension:
$ echo -n "echo 'hello, <arg>!'" > example.snippet
$ snippet -t example.snippet world!
  1. Create a template using the -e | --edit argument:
# Create a template called example with the specified string format
$ snippet -e example -f "echo 'hello, <arg>!'"
# Open vim to edit or add a new template
$ snippet -e example world!
# Use the template
$ snippet -t example world!

If you have bash-completion enabled you can press <TAB> twice to autocomplete template names.

In addition the -t | --template argument will open an interactive search prompt when the specified template name was not found.

To list all available templates you can use the --list-templates parameter.

Using codecs

snippet supports simple string transformation. A list of available codecs can be viewed by using the --list-codecs argument.

To transform a placeholder use the <PLACEHOLDER[|CODEC[:ARGUMENT] ...]> format:

$ snippet -f "<arg|b64>" "hello snippet"
aGVsbG8gcmV2YW1w
$ snippet -f "<arg> <arg|b64|b64>" "hello snippet"
hello snippet YUdWc2JHOGdjbVYyWVcxdw==
$ snippet -f "<arg...|join:', '>!" arg=hello snippet
hello, snippet!

Using defaults

snippet supports specifying default values for your placeholders:

$ snippet -f "<arg1> <arg2='default'>" hello
hello default

Using optionals

snippet supports specifying optional parts in the string format by surrounding them with square-brackets:

$ snippet -f "<arg1> [<arg2>]" hello snippet
hello snippet
$ snippet -f "<arg1> [<arg2>]" hello
hello
$ snippet -f "<arg> [my <arg2='snippet'>]" hello
hello my snippet
$ snippet -f "<arg> [my <arg2='snippet'>]" hello arg2=
hello

If you need square-brackets to be part of the string format you need to escape them accordingly:

$ snippet -f "\[<arg>\]" hello
[hello]

Using repeatables

If you specify multiple values for placeholders snippet will print all possible permutations. Since this is not always the thing you wanna do snippet allows marking placeholders as repeatable. This is done by placing three dots at the end of a placeholder. By default arguments which are associated with a repeatable placeholder are separated by space. To specify a custom character sequence you may use the join codec:

$ snippet -f "<arg1>" hello world
hello
world
$ snippet -f "<arg1...>" hello world
hello world
$ snippet -f "<arg1...|join:','>" hello world
hello,world

Executing commands

snippet can be used to easily execute alternating commands in sequence:

$ snippet -f "echo 'hello <arg1>';" arg1=snippet world | bash
hello world
hello snippet

Using xargs the resulting commands can also be executed in parallel:

snippet -f "echo 'hello <arg1>';" arg1=snippet arg1=world | xargs --max-procs=4 -I CMD bash -c CMD
hello world
hello snippet

See also

To make the most out of this tool you might also consider to look into the following projects:

  • bgl - manage global bash environment variables

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for snippet-cli, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size snippet_cli-2.0.1-py3-none-any.whl (42.4 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page