https://github.com/jakeswenson/otpcli

A TOTP code generator for the CLI that securely stores secrets in the keychain
https://github.com/jakeswenson/otpcli

cli totp totp-cli totp-codes totp-generator totp-tokens

Last synced: 4 months ago
JSON representation

A TOTP code generator for the CLI that securely stores secrets in the keychain

• Host: GitHub
• URL: https://github.com/jakeswenson/otpcli
• Owner: jakeswenson
• License: mit
• Created: 2018-08-24T16:48:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T17:46:58.000Z (about 2 years ago)
• Last Synced: 2025-08-29T19:44:03.698Z (10 months ago)
• Topics: cli, totp, totp-cli, totp-codes, totp-generator, totp-tokens
• Language: Rust
• Homepage:
• Size: 193 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OTP Cli

[![Crates.io](https://img.shields.io/crates/v/otpcli.svg?style=for-the-badge)](https://crates.io/crates/otpcli)

[![Build Status](https://img.shields.io/github/workflow/status/jakeswenson/otpcli/Build?style=for-the-badge)](https://github.com/jakeswenson/otpcli/actions?query=workflow%3ABuild)

A one time password library and CLI tool for generating time-based one time passwords.

Also supports RSA Secure tokens (using the rust stoken library)

## Installing

You can install with `cargo`

```bash

cargo install otpcli

```

## Features

- **[DEFAULT]** `copy`: build with copy to [clipboard](https://crates.io/crates/clipboard) support. Adds a `--copy` cli option.

- **[DEFAULT]** `keychain`: build with secure secret storage support using [`keyring`](https://crates.io/crates/keyring).

- `rsa_stoken`: add in `stoken` support using the stoken crate.

The `copy` feature uses [clipboard](https://crates.io/crates/clipboard) 

and that requires a X11 on linux to access the clipboard

## CLI

```bash

A simple one-time-password CLI, with support for TOTP and STOKEN.

USAGE:

    otpcli [FLAGS] [name] [SUBCOMMAND]

FLAGS:

        --copy       Copies the generated token to the clipboard

    -n, --newline    Adds a newline printed at the end out output

    -h, --help       Prints help information

    -V, --version    Prints version information

    -v, --verbose

ARGS:

        The name of the totp token to generate

SUBCOMMANDS:

    add                    Add/Update a new TOTP secret

    delete                 Add/Update a new TOTP secret

    generate               Generate a token

    help                   Prints this message or the help of the given subcommand(s)

    import                 Import an RSAToken into otpcli (if built with the stoken flag)

    list                   Add/Update a new TOTP secret

    migrate-to-keychain    Migrate secrets stored in the config to be stored in the keychain

```

# Release process

Releases of `otpcli` are fully automated using GitHub Actions and initiated from [`cargo-release`](https://github.com/sunng87/cargo-release).

To trigger a new release, run `cargo release ` where `` is one of the support `cargo release` options:

- `alpha`

- `beta`

- `rc`

- `patch`

- `minor`

- `major`