Command Line Usage¶
sncli [OPTIONS] [COMMAND] [COMMAND_ARGS]
Options¶
-
<none>¶ Open
sncliin the console GUI.
-
-c<file>¶
-
--config=<file>¶ Sets the configuration used by
sncli. The default is$HOME/.snclirc. See Example Configuration.
-
-h¶
-
--help¶ View
snclioptions and subcommands.
-
-k<key>¶
-
--key=<key>¶ Idenifies a note by its key.
-
-n¶
-
--nosync¶ Prevent
snclifrom performing a server sync.
-
-r¶
-
--regex¶ This will cause
snclisearch strings as a regular expression. See Search Styles for more.
-
-t<title>¶
-
--title=<title>¶ If creating a new note from
stdin, this will allow you to set the title to <title>.
-
-v¶
-
--verbose¶ Displays the command’s verbose output.
Commands¶
Notes¶
-
create¶ Opens a new note in the editor.
echo [your note content here] | sncli -t <title> create -
Note
Creating a note from stdin is the only command that accepts -t <title>.
-
dump¶ Dump notes in plain text format to
stdin.
sncli dump
sncli -k <key> dump
sncli dump [search_string]
sncli -r dump [search_string]
-
edit¶ Opens the specific note in the editor..
sncli -k <key> edit
-
export¶ Export notes in JSON to
stdin.
sncli -k <key> export
sncli export [search_string]
sncli -r export [search_string]
-
import¶ Import a JSON formatted note.
Fields are: content; tags; systemTags; modificationDate; creationDate; deleted
echo '{"tags":["testing","new"],"content":"New note!"}' | sncli import -
-
list¶ List all notes by
key [flags] title.
sncli list [search_string]
sncli list -r [search_string]
-
sync¶ Performs a full, bi-directional sync between the local notes cache and the Simplenote server.
Flags¶
-
pin| unpin¶ Pin or unpin a specific note.
sncli -k <key> pin
sncli -k <key> unpin
-
markdown| unmarkdown¶ Add or remove the markdown as the note’s file type.
sncli -k <key> markdown
sncli -k <key> unmarkdown
-
trash| untrash¶ Move a note to or from trash.
sncli -k <key> trash
sncli -k <key> untrash
Tags¶
-
tag<add|get|rm|set>¶ Manage your note’s tags.
sncli -k <key> tag add <tags>
Add tag <text> to a specific note.
sncli -k <key> tag get
List the tags of a specific note in stdin.
sncli -k <key> tag rm <tags>
Remove tag <tags> from a specific note.
sncli -k <key> tag set <tags>
Set <tags> as tags for a specific note.
Note
tag set will overwrite all previous tags for the specific note.