Skip to content
A simple command line app to store and retrieve passwords securely.
Branch: master
Clone or download
Jeremie Castagna
Jeremie Castagna update history and version
Latest commit b80d92a Jul 18, 2012
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin removed warning mode in yak for ruby 1.9 Feb 16, 2011
lib update history and version Jul 18, 2012
script added bash completion support Feb 24, 2010
.gitignore first commit Feb 23, 2010
History.txt update history and version Jul 18, 2012
Manifest.txt added bash completion support Feb 24, 2010
README.txt update gemfile info Jul 18, 2012
Rakefile renaming to yak - pez gem is taken Feb 23, 2010


= Yak

== Description

Yak is a simple command line app to store and retrieve passwords securely
under a master password, and allows one password repository per system user.
Retrieved passwords get copied to the clipboard by default.

== Configuration

Config can be set in ~/.yakrc.

Session is the length of time in seconds that Yak will remember the
master password:
  :session : 30

If using sessions is not desired and you want to enter the
master password every time, set:
  :session : false

Always set the password by default, use:
  :password : plain_text_password

Turn off password confirmation prompts when a new password is entered:
  :confirm_prompt : false

Using bash completion for stored keys:
  :bash_completion : true    #=> completion only available during session
  :bash_completion : :always #=> completion always available (keys exposed)

== Usage

Yak will always prompt you for the master password unless a yak session is
present, or the :password option is set in ~/.yakrc.
Yak sessions get refreshed everytime yak is called.

Adding a new password:
  $ yak -a gmail
  # prompts user for gmail password to save

  $ yak -a gmail my_password
  # uses my_password as gmail password and overwrites old value

Retrieving a saved password:
  $ yak gmail
  # copies the gmail password to the clipboard

  $ yak -p gmail
  >> my_password
  # outputs gmail password to stdout

Removing a stored password:
  $ yak -r gmail
  # deletes gmail entry completely

Changing the master password:
  $ yak -n
  # prompts for old password first, then the new password

Listing keys:
  $ yak --list
  # returns all saved keys

  $ yak --list key
  # returns all keys matching /key/

  $ yak --list ^key$
  # returns unique key matching /^key$/
You can’t perform that action at this time.