npm package: @snipp/cli
Description: Privacy-aware snippet manager
Author: snipp.sh @snippsh
Latest version: 0.0.8

@snipp/cli
==========

Privacy-aware CLI snippet manager

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@snipp/cli.svg)](https://npmjs.org/package/@snipp/cli)
[![Downloads/week](https://img.shields.io/npm/dw/@snipp/cli.svg)](https://npmjs.org/package/@snipp/cli)
[![License](https://img.shields.io/npm/l/@snipp/cli.svg)](https://github.com/snippsh/cli/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @snipp/cli
$ snipp COMMAND
running command...
$ snipp (-v|--version|version)
@snipp/cli/0.0.8 darwin-x64 node-v14.15.0
$ snipp --help [COMMAND]
USAGE
  $ snipp COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`snipp configure`](#snipp-configure)
* [`snipp create`](#snipp-create)
* [`snipp help [COMMAND]`](#snipp-help-command)
* [`snipp invite`](#snipp-invite)
* [`snipp list`](#snipp-list)
* [`snipp read ID`](#snipp-read-id)
* [`snipp share ID`](#snipp-share-id)

## `snipp configure`

configure snipp

```
USAGE
  $ snipp configure

OPTIONS
  -h, --help   show CLI help
  -q, --quiet  suppress debug output

EXAMPLE
  $ snipp configure
```

_See code: [src/commands/configure.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/configure.ts)_

## `snipp create`

create a snipp

```
USAGE
  $ snipp create

OPTIONS
  -f, --file=credentials.csv     file
  -h, --help                     show CLI help
  -n, --name="My first snippet"  display name
  -q, --quiet                    suppress debug output
  -y, --skip                     skip confirm prompts
  --data="Hello, World\!"        data
  --description="Testing snipp"  brief description
  --stdin                        use stdin to provide data

EXAMPLES
  $ snipp create --data "Hello, World\!" --name "My first snippet" --description "Testing snipp"
  $ snipp create --file credentials.csv --name "Terraform AWS Credentials for Sandbox"
  $ snipp create --file temp.txt -y
  $ snipp create --name "Terraform AWS Credentials for Sandbox" --stdin < credentials.csv
```

_See code: [src/commands/create.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/create.ts)_

## `snipp help [COMMAND]`

display help for snipp

```
USAGE
  $ snipp help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_

## `snipp invite`

invite a user to snipp

```
USAGE
  $ snipp invite

OPTIONS
  -e, --email=me@someone.else  (required) email address
  -h, --help                   show CLI help
  -q, --quiet                  suppress debug output

EXAMPLE
  $ snipp invite --email me@someone.else
```

_See code: [src/commands/invite.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/invite.ts)_

## `snipp list`

list snipps owned by or shared with you

```
USAGE
  $ snipp list

OPTIONS
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

EXAMPLES
  $ snipp list
  $ snipp list --output json
  $ snipp list --filter name=.csv
  $ snipp list --output csv --filter name=.csv
  $ snipp list --columns id,name --output csv --filter name=.csv
```

_See code: [src/commands/list.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/list.ts)_

## `snipp read ID`

read the contents of a snipp

```
USAGE
  $ snipp read ID

OPTIONS
  -h, --help                           show CLI help
  -o, --output=credentials.csv         output path
  -p, --passphrase=MySecretPassphrase  passphrase protecting the private key
  -q, --quiet                          suppress debug output

EXAMPLES
  $ snipp read 42
  $ snipp read 42 -p MySecretPassphrase
  $ snipp read 42 -o credentials.csv
  $ snipp read 42 -o credentials.csv -p MySecretPassphrase
  $ snipp read 42 -q -p MySecretPassphrase | pbcopy
```

_See code: [src/commands/read.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/read.ts)_

## `snipp share ID`

share a snipp

```
USAGE
  $ snipp share ID

OPTIONS
  -e, --email=me@someone.else          (required) email address
  -h, --help                           show CLI help
  -p, --passphrase=MySecretPassphrase  passphrase protecting the private key
  -q, --quiet                          suppress debug output

EXAMPLES
  $ snipp share 42 --email me@someone.else
  $ snipp share 42 -e me@someone.else -p MySecretPassphrase
```

_See code: [src/commands/share.ts](https://github.com/snippsh/cli/blob/v0.0.8/src/commands/share.ts)_
<!-- commandsstop -->