kickpass1

A stupid simple password safe

Usage

kickpass [-hv]

kickpass help [command]

kickpass init [sub]

kickpass cat [-p] safe

kickpass create [-gl len] safe

kickpass open [-t] safe

kickpass edit [-pmgl] safe

kickpass copy safe

kickpass list [path]

kickpass delete safe

kickpass agent [-d] [command [arg ...]]

Overview

kickpass is a stupid simple password safe. It keep each password in a specific safe, protected with modern cryptography. Command line interface is splited into different command. Each is described in the following subsections.

Workspace

All safes are stored in kickpass workspace. Default workspace is $HOME/.kickpass/ .

Safe naming

Safe name can contains any character allowed by the file system containing the kickpass workspace. If safe name contains ‘/’ then corresponding directories will be created under kickpass workspace. For example the following command

kickpass create www/my-personnal-website

will create a safe in $HOME/.kickpass/www/my-personnal-website . While following command

kickpass list www

will list all safe under the directory $HOME/.kickpass/www/ .

Nm Oo Fl hv Oc

Don't do anything

-v --version: Print kickpass version
-h --help: Print kickpass help

Nm Cm help Oo Ar command Oc

Print general help or command help.

Nm Cm init Oo Ar sub Oc

Initialize a kickpass workspace or a sub-workspace.

Nm Cm cat Oo Fl p Oc Ar safe

Open safe and print safe metadata to stdout.

-p --password: Print the password to stdout

Nm Cm create Oo Fl gl Oc Ar safe

Create a new password safe.

-g --generate: Create a new safe with a generated random password
-l --length len: Generate a random password of len length

Nm Cm open Oo Fl t Oc Ar safe

Open safe and load it in kickpass agent

-t --timeout: Sets the lifetime of the opened safe in the agent. Default in seconds (3600s).

Nm Cm edit Oo Fl pmgl Oc Ar safe

Prompt for a new password and edit metadata from safe using EDITOR environment variable

-p --password: Edit only password
-m --metadata: Edit only metadata
-g --generate: Create a new safe with a generated random password
-l --length len: Generate a random password of len length

Nm Cm copy Ar safe

Copy safe password into X primary and secondary clipboards. Password can be pasted only once.

Nm Cm list Oo Ar path Oc

List available safes starting from path relatively to kickpass workspace or from root of kickpass workspace if path is not given.

Nm Cm delete Oo Fl f Oc Ar safe

Delete safe .

Nm Cm agent Oo Fl d Oc Oo Ar command Oo arg ... Oc Oc

Start a kickpass agent that will store your opened safe. Agent can be used by exporting KP_AGENT_SOCK environment variable. Optionally starts command with the correct environment set.

-d --version: Do not daemonize agent.

Environment

The following variables are used by kickpass:

HOME: The user's login directory. Used to compute kickpass workspace path.
EDITOR: The user's preferred utility to edit text files. Used to edit safe.
KP_AGENT_SOCK: Socket used to communicate with kickpass agent. Path to socket is printed to stdout when at agent startup.

Files

The following files and directories are used by kickpass:

$HOME/.kickpass/: The kickpass working directory.

Examples

Initialize a kickpass workspace.

kickpass init

Create a new safe with a random password.

kickpass create -g www/my_safe

Display safe content on stdout.

kickpass cat www/my_safe

Edit a safe.

kickpass edit www/my_safe

Copy password contained in safe into X clipboards.

kickpass copy www/my_safe

Releases

Unchanged in 4 releases since Debian 10 (Buster).

10–13