KICKPASS(1)

📦 version 0.2.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

👑 KICKPASS — the manual, but make it cute 💖

okay so bestie, gather round, because kickpass is here and it's literally a stupid simple password safe and I'm obsessed 🎀

✨ NAME ✨

kickpass — a stupid simple password safe 🫶

🌸 SYNOPSIS 🌸

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 ...]]

💅 DESCRIPTION 💅

so kickpass is a stupid simple password safe. It keeps each password in a specific safe, protected with modern cryptography, no cap. The command line interface is splited into different commands, and each one gets its own little subsection below. slay. ✨

🏠 WORKSPACE 🏠

All safes are stored in the kickpass workspace. The default workspace is $HOME/.kickpass/ — that's home base, that's where everything lives. 💜

🗂️ SAFE NAMING 🗂️

A safe name can contain any character that's allowed by the file system holding the kickpass workspace. And here's the fun part: if the safe name contains /, then the corresponding directories get created under the kickpass workspace. it's giving folders, bestie. 🌈

So for example, this command

kickpass create www/my-personnal-website

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

kickpass list www

will list all safes under the directory $HOME/.kickpass/www/. see? iconic. 👑

🎀 COMMANDS 🎀

🦋 kickpass [-hv]

Don't do anything. literally nothing. main character energy of doing absolutely zero. 💀

  • -v, --version — Print kickpass version
  • -h, --help — Print kickpass help

🦋 kickpass help [command]

Print general help, or help for a specific command. iykyk. 💖

🦋 kickpass init [sub]

Initialize a kickpass workspace, or a sub-workspace. ✨

🦋 kickpass cat [-p] safe

Open a safe and print the safe metadata to stdout.

  • -p, --password — Print the password to stdout

🦋 kickpass create [-gl] safe

Create a new password safe. fresh safe, who dis 🎀

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

🦋 kickpass open [-t] safe

Open a safe and load it in the kickpass agent.

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

🦋 kickpass edit [-pmgl] safe

Prompt for a new password and edit metadata from the safe, using the 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

🦋 kickpass copy safe

Copy the safe password into the X primary and secondary clipboards. ⚠️ and listen: the password can be pasted only once. one paste and it's gone, so be careful bestie, don't waste it 😭

🦋 kickpass list [path]

List available safes starting from path, relatively to the kickpass workspace — or from the root of the kickpass workspace if path isn't given. 🌸

🦋 kickpass delete [-f] safe

Delete safe. bye bye safe 🫶

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

Start a kickpass agent that will store your opened safes. The agent can be used by exporting the KP_AGENT_SOCK environment variable. Optionally it starts command with the correct environment already set. so convenient, honestly 💅

  • -d, --version — Do not daemonize agent.

🌈 ENVIRONMENT 🌈

These are the variables kickpass uses, bestie:

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

🍓 FILES 🍓

Files and directories that kickpass uses:

  • $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 the password contained in a safe into the X clipboards.

kickpass copy www/my_safe

💜 AUTHORS 💜

kickpass is written by Paul Fariello <paul@fariello.eu>. king behavior honestly 👑

and that's the whole thing, babe 🧚 this page came from the Debian crew, dated May 5, 2017 — go forth and keep your passwords safe, periodt. 💖✨

📦 where this page comes from