posce 0.3.0

A note-taking toolkit for your command line.

Posce

Posce (pronounced posh·ee) is a note-taking toolkit for your command line. It takes a single directory of plaintext note files and lets you create, edit, manipulate, and organise them to your heart's content.

• See changes.md for a complete changelog.
• See license.md for licensing information.

Installation

Posce required Python 3.8 or higher. To install, you can:

• Run pip install posce, or
• Download the latest release.

Configuration

Posce only requires you to set two environment variables:

# The path to your notes directory.
POSCE_DIR = "~/notes"

# The extension your note files use (no dot).
POSCE_EXT = "txt"

On macOS and Linux, these variables can be set in your shell profile script, most likely $HOME/.profile. On Windows, you can set them in the "Environment Variables" subscreen in System Properties (search "environment" in your Start Menu).

Usage

Notes are always referred to by their pure name, no extension or filepath. In addition, notes and commands are disambiguated, which means you can write abbreviated versions and — if it's unambiguous — Posce will automatically expand them for you.

Example.

If you have a directory that looks like this:

- ~/notes
    - josh.txt
    - sam.txt
    - toby.txt

Then your notes will look like this:

$ posce list
josh
sam
toby

$ posce show j
"Toby, come quick, Sam's getting his ass kicked by a girl!"

And you can abbreviate commands like this:

$ posce l
josh
sam
toby

$ posce s j
"Toby, come quick, Sam's getting his ass kicked by a girl!"

I recommend aliasing posce to p for maximum brevity.

Commands

Required arguments are marked with <angles>, optional arguments with [brackets], choices are in (parentheses).

copy <NAME> <DEST>

Copy an existing note to a different name.

Example.

$ posce copy ed larry
# Copy "ed.txt" to "larry.txt".

dump <DEST> [-l]

Create a zip archive of your notes directory.

Argument	Description	Default
-l --level	Compression level (from 0 to 9).	5.

Example.

$ posce dump notes.zip
# Create "notes.zip" in current directory.

$ posce dump notes.zip -l 9
# Create "notes.zip" with maximum compression.

edit <NAME> [-en]

Edit an existing note.

Argument	Description	Default
-e --editor	Open note in this program.	System default.

Example.

$ posce edit toby
# Open "toby.txt" in your default editor.

$ posce edit toby -e notepad
# Open "toby.txt" in Notepad.

find <TERM> [-r]

List all notes containing a substring or matching a regular expression.

Argument	Description	Default
-r --regex	Use search term as regular expression.	Disabled.

Example.

$ posce find "jackass"
josh
toby

$ posce find "It's on page \d{1,3}!" -r
claudia

list [GLOB] [-rs]

List all notes, or notes matching GLOB (default *).

Argument	Description	Default
-r --reverse	Reverse sort order.	Disabled.
-s --sort (name|size)	Sort notes by this field.	name.

Example.

$ posce list
charlie
claudia
josh
sam
toby

$ posce list c* -r -s name
claudia
charlie

move <NAME> <DEST>

Move an existing note to a different name.

Example.

$ posce move claudia cj
# Move "claudia.txt" to "cj.txt".

show <NAME> [-w]

Print an existing note's contents.

Argument	Description	Default
-w --wrap <int>	Wrap text to width <int>.	Disabled.

Example.

$ posce show claudia
"I had woot canal!"

$ posce show sam -w 40
"Over three and a half centuries ago,
linked by faith and bound by a common
desire for liberty, a small band of
pilgrims sought out a place in the New
World where they could worship according
to their own beliefs... and solve
crimes."

wget <NAME> <URL>

Download a URL to an existing note.

Example.

$ posce copy josh lemon-lyman.com
# Download "http://lemon-lyman.com" to "josh.txt".

Contribution

Bugs, suggestions, and feature requests are welcome! Please add them to the issue tracker with an appropriate label.