Skip to content

DishIs/fce-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fce — FreeCustom.Email CLI

______             _____           _                    _____                _ _ 
|  ___|           /  __ \         | |                  |  ___|              (_) |
| |_ _ __ ___  ___| /  \/_   _ ___| |_ ___  _ __ ___   | |__ _ __ ___   __ _ _| |
|  _| '__/ _ \/ _ \ |   | | | / __| __/ _ \| '_ ` _ \  |  __| '_ ` _ \ / _` | | |
| | | | |  __/  __/ \__/\ |_| \__ \ || (_) | | | | | |_| |__| | | | | | (_| | | |
\_| |_|  \___|\___|\____/\__,_|___/\__\___/|_| |_| |_(_)____/_| |_| |_|\__,_|_|_|
                                                                                 
                                                                                 
  FreeCustom.Email
  disposable inbox API

Manage disposable inboxes, extract OTPs, and stream real-time email events from your terminal — in under 30 seconds.


Install

curl -fsSL freecustom.email/install.sh | sh

(Or use your preferred package manager below)

macOS/Linux (Homebrew)

brew tap DishIs/homebrew-tap
brew install fce

Windows (Scoop)

scoop bucket add fce https://github.com/DishIs/scoop-bucket
scoop install fce

Windows (Chocolatey)

choco install fce

Shell Script (macOS/Linux)

curl -sSfL https://raw.githubusercontent.com/DishIs/fce-cli/main/scripts/install.sh | sh

Go install

go install github.com/DishIs/fce-cli@latest

Update

When a new version is released, you can update the CLI using your package manager:

Homebrew

brew update
brew upgrade fce

Scoop

scoop update fce

Chocolatey

choco upgrade fce

NPM

npm install -g fcemail@latest

Shell Script Simply re-run the installation command or use the built-in update:

fce update

Uninstall

To remove the CLI and all local configuration:

  1. Clear Config & Credentials

    fce uninstall

    (This clears your API key and local cache)

  2. Remove the Binary

    • Homebrew: brew uninstall fce
    • Scoop: scoop uninstall fce
    • Choco: choco uninstall fce
    • NPM: npm uninstall -g fcemail
    • Manual: sudo rm /usr/local/bin/fce

Or download a binary from Releases.


Quick start

# 1. Login — opens your browser
fce login

# 2. Watch a random inbox for emails in real time
fce watch random

# 3. Or watch a specific one
fce watch mytest@ditmail.info

Commands

Command Description Plan required
fce login Authenticate via browser Any
fce logout Remove stored credentials Any
fce status Account info, plan, inbox counts Any
fce usage Request usage for current period Any
fce inbox list List registered inboxes Any
fce inbox add <addr> Register a new inbox Any
fce inbox add random Register a random inbox Any
fce inbox remove <addr> Unregister an inbox Any
fce messages <inbox> [id] List messages or view a specific message Any
fce domains List available domains Any
fce watch [inbox|random] Stream emails via WebSocket Startup+
fce otp <inbox> Get latest OTP from an inbox Growth+
fce dev Instantly register a dev inbox and start watching Any
fce update Update the CLI to the latest version Any
fce uninstall Remove all local config and credentials Any
fce version Show version info Any

Examples

# Register + watch a random inbox
fce inbox add random
fce watch random

# Watch a specific inbox (Startup plan+)
fce watch alerts@ditmail.info

# Get the latest OTP (Growth plan+)
fce otp mytest@ditmail.info

# Check quota
fce usage

# List all your inboxes
fce inbox ls

Authentication

fce login opens your browser to www.freecustom.email. Sign in with GitHub, Google, or a magic link — a new API key is created and stored securely in your OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service / libsecret).

You can also set the FCE_API_KEY environment variable to skip the keychain entirely — useful in CI:

export FCE_API_KEY=fce_your_key_here
fce status

Plan limits

Feature Free Developer Startup Growth Enterprise
All basic commands
fce watch (WebSocket)
fce otp

Upgrade at: https://www.freecustom.email/api/pricing


Build from source

git clone https://github.com/DishIs/fce-cli
cd fce
go build -o fce .
./fce --help

Cross-platform release build (requires goreleaser):

goreleaser build --clean --snapshot
# Binaries in dist/

CI usage

# GitHub Actions example
- name: Get OTP
  env:
    FCE_API_KEY: ${{ secrets.FCE_API_KEY }}
  run: |
    fce inbox add random > /tmp/inbox.txt
    INBOX=$(cat /tmp/inbox.txt | grep -o '[a-z0-9@.]*')
    # trigger your app to send email to $INBOX
    OTP=$(fce otp $INBOX)
    echo "OTP: $OTP"

License

MIT © FreeCustom.Email

About

CLI for FreeCustom.Email, manage disposable inboxes, extract OTPs, and stream real-time temporary email events from your terminal — for the first time.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors