Skip to content

Commit

Permalink
Update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
Mitchell Stanley committed Sep 2, 2019
1 parent 1c9c0b5 commit 77e6bc4
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ Log-in to your Snipline account and sync your snippets.
Follow login instructions (Enter email and token)

```bash
snipline login
snipcli login
```

Download snippets from your account

```bash
snipline sync
snipcli sync
```

This will create two files on your system: `~/.config/snipline/config.toml` and `~/.config/snipline/snippets.json`.
Expand All @@ -60,7 +60,7 @@ This will create two files on your system: `~/.config/snipline/config.toml` and
A basic search can be done with the `search` command.

```bash
snipline search <searchterm>
snipcli search <searchterm>
```

By default search will ask if you wish to copy the result to clipboard, to run the result in the current terminal, use the `run` flag.
Expand All @@ -71,6 +71,8 @@ snipline search <searchterm> --run

Search options include `field`, `limit`, `run`. See `snipcli search --help` for more information

Note that as of 0.2.0 it's not possible to search and copy to clipboard from a Linux VM/SSH session. Select `no` when prompted to copy to clipboard to continue and use the `--run` flag to run the command instead.

### Creating a new snippet

You can create a new snippet by using the `new` command. This will open a TOML file in the text editor of your preference. Once closed it will attempt to add it to your `snippets.json` file and sync to Snipline Cloud.
Expand Down

0 comments on commit 77e6bc4

Please sign in to comment.