<commit_before>gacli
=====

The ``ga`` command line utility provides convenient access to TOTP verification
codes: ::

    usage: ga [-h] [-d] [-f FILE]

    Copy newline terminated TOTP verification code to Mac OS X clipboard.

    optional arguments:
      -h, --help            show this help message and exit
      -d, --debug           print debug information
      -f FILE, --file FILE  Secret file

    The debug option continually prints verification codes instead of copying a
    single code to the clipboard.


Install
=======

Simple
------

1. Ensure you are using `FileVault 2`_ on Mac OS X Lion or later
2. Install ``gacli`` python module: ::

       sudo pip install https://github.com/ClockworkNet/gacli/archive/master.zip#egg=gacli

VirtualEnv and User Bin
-----------------------

The following instructions assume your shell adds ``~/bin`` to your path and that you have virtualenv_ and virtualenvwrapper_ installed.

1. Ensure you are using `FileVault 2`_ on Mac OS X Lion or later
2. Create gacli virtualenv and install ``gacli`` python module: ::

       mkvirtualenv -i https://github.com/ClockworkNet/gacli/archive/master.zip#egg=gacli gacli

3. Symlink ``ga`` to home bin: ::

       ln -s $(which ga) ~/bin/

.. _`FileVault 2`: http://support.apple.com/kb/HT4790
.. _virtualenv: http://www.virtualenv.org/
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/


Configuration
=============

The ``ga`` script excepts your secret key (the first line in
``.google_authenticator``) to be located in ``~/.ga``.


Related
=======

* mac-ssh-confirm_: Protect against SSH Agent Hijacking on Mac OS X with the
  ability to confirm agent identities prior to each use

.. _mac-ssh-confirm: https://github.com/TimZehta/mac-ssh-confirm


Requirements
============

- Mac OS X Lion or Mountain Lion
- onetimepass_

.. _onetimepass: https://github.com/tadeck/onetimepass


License
=======

gacli is licensed under the `BSD 2-Clause License <http://www.opensource.org/licenses/BSD-2-Clause>`_: ::

    Copyright (c) 2013, Clockwork Active Media Systems<commit_msg>README reorganized, clarified, and extended<commit_after>gacli
=====

``gacli`` was created for used with google-authenticator_. Thankfully, TOTP_ is
an open standard so ``gacli`` may have additional applications.

The ``ga`` command line utility provides convenient access to TOTP verification
codes: ::

    usage: ga [-h] [-d] [-f FILE]

    Copy newline terminated TOTP verification code to Mac OS X clipboard.

    optional arguments:
      -h, --help            show this help message and exit
      -d, --debug           print debug information
      -f FILE, --file FILE  Secret file

    The debug option continually prints verification codes instead of copying a
    single code to the clipboard.

.. _google-authenticator: https://code.google.com/p/google-authenticator/
.. _TOTP: http://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm


Install
=======

Choose *either* the Simple *or* VirtualEnv and User Bin installation:

Simple
------

1. Install ``gacli`` python module: ::

       sudo pip install https://github.com/ClockworkNet/gacli/archive/master.zip#egg=gacli

VirtualEnv and User Bin
-----------------------

The following instructions assume your shell adds ``~/bin`` to your path and that you have virtualenv_ and virtualenvwrapper_ installed.

1. Create gacli virtualenv and install ``gacli`` python module: ::

       mkvirtualenv -i https://github.com/ClockworkNet/gacli/archive/master.zip#egg=gacli gacli

2. Symlink ``ga`` to home bin: ::

       ln -s $(which ga) ~/bin/

.. _`FileVault 2`: http://support.apple.com/kb/HT4790
.. _virtualenv: http://www.virtualenv.org/
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/


Configuration
=============

1. Ensure you are using disk encryption (ex. `FileVault 2`_ on Mac OS X Lion or
   later)
2. Copy the secret key from the first line of your ``.google_authenticator``
   and put in ``~/.ga``
3. ``chmod 0400 ~/.ga``


Related
=======

* mac-ssh-confirm_: Protect against SSH Agent Hijacking on Mac OS X with the
  ability to confirm agent identities prior to each use

.. _mac-ssh-confirm: https://github.com/TimZehta/mac-ssh-confirm


Requirements
============

- Mac OS X Lion or Mountain Lion
- onetimepass_

.. _onetimepass: https://github.com/tadeck/onetimepass


License
=======

gacli is licensed under the `BSD 2-Clause License <http://www.opensource.org/licenses/BSD-2-Clause>`_: ::

    Copyright (c) 2013, Clockwork Active Media Systems
{'fraction_non_alphanumeric': 0.13298337707786526, 'fraction_numerical': 0.008748906386701663, 'mean_word_length': 3.297932330827068, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 9, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2669784', 'n_tokens_mistral': 1448, 'n_tokens_neox': 1341, 'n_words': 488}