Skip to content

joedemcher/simplelogin-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simplelogin CLI

A command-line interface for Simplelogin.

Setup

  1. Install the CLI
    Run the following command to install Simplelogin CLI via pip:

    pip install simplelogin
  2. Set Environmental Variables
    To configure the CLI, you'll need to set up two environment variables in your shell:

    • SIMPLELOGIN_API_URL
      Define the base URL for the Simplelogin API. You can set it to the default Simplelogin URL or your custom domain.
      Example:

      export SIMPLELOGIN_API_URL=https://app.simplelogin.io
    • SIMPLELOGIN_EMAIL
      Specify the email address you use to sign in to Simplelogin.
      Example:

      export SIMPLELOGIN_EMAIL=your-email@example.com

    Note: To make these variables persistent across sessions, add them to your shell's configuration file (e.g., .bashrc, .zshrc, or .bash_profile).

Capabilities

  • Login to account (login)
    • Supports Multi-Factor Authentication (MFA)
  • Logout (logout)
  • Search aliases (alias)
    • Search using flags (e.g., alias --pinned)
  • Get user stats (stats)
  • Generate custom alias (create)
  • Generate random alias (random)
  • Delete an alias (delete)
  • Disable/enable an alias (toggle)
  • Help (--help) available for all commands
  • Secure API key storage in the system's keyring service 🔑

Todos

  • Lower the required Python version (currently requires Python 3.12)
  • Add tests
  • Improve commenting