[ 01 / 07 ]·CLI Overview

FreeCustom.Email
in your terminal

Create disposable inboxes, stream incoming emails, and extract OTP codes — all from your terminal. One command to get started.

Quick Install
bash
npm install -g fcemail
  • Login instantly with fce login — browser-based, keychain-backed
  • Real-time WebSocket streaming (< 200ms)
  • Automatic OTP extraction — no regex
  • CI/CD ready: set FCE_API_KEY to skip interactive login
fce — install
~%

0+

API Calls / Day

0+

Emails / Day

0+

Developers

[ 03 / 07 ]·Installation

Get started in seconds

Available via npm, Homebrew, Scoop, Chocolatey, a shell script, or built from source. We auto-detected your platform below.

Platform
← detected
bash
npm install -g fcemail

Or download a binary from GitHub Releases

Login

bash
fce login
# Opens browser → sign in → key saved to keychain

One-time setup. API keys are auto-created and always reflect your current plan.

CI / CD — skip keychain

bash
# In GitHub Actions / any pipeline:
export FCE_API_KEY=${{ secrets.FCE_API_KEY }}
fce status

Get your key from the dashboard after fce login. Set it as a CI secret.

Keychain-backed locally · API keys update automatically with your plan.

[ 04 / 07 ]·fce dev — start here
THE FASTEST WAY TO START

One command.
Inbox ready.
Emails streaming.

fce dev combines fce inbox add random + fce watch into a single command.

  • Auto-generates a fresh disposable address
  • Immediately opens WebSocket connection
  • Emails arrive in terminal in real time
  • OTP codes highlighted automatically
  • Press Ctrl+C to stop — inbox auto-cleaned
bash
fce dev
⚡ fce dev1 command. all-in-one.
~%fce dev
[ 05 / 07 ]·Try It — Interactive Demo

Run commands in your browser

This demo mirrors the real CLI exactly. Login, create inboxes, watch for emails, and extract OTPs. Use for command history, Esc to stop watching.

fce — interactive demo
◉ fce — FreeCustom.Email CLI demo
Type a command and press Enter.
Try: fce login or fce help
~%
Try:
[ 05 / 07 ]·Reference

All commands

01

fce login

Authenticate via browser

Any

02

fce logout

Remove stored credentials

Any
⚡ start

03

fce dev

Register dev inbox + watch instantly

Any

04

fce watch [inbox]

Stream emails via WebSocket

Growth+

05

fce otp <inbox>

Extract latest OTP code

Developer+

06

fce timeline <inbox>

View inbox event timeline

Startup+

07

fce insights <inbox>

View failure insights for inbox

Growth+

08

fce status

View account and plan

Any

09

fce inbox

Manage registered addresses

Any

10

fce messages

List messages in an inbox

Any

11

fce usage

Check credit consumption

Any

12

fce domains

List available domains

Any

13

fce update

Update CLI to latest version

Any

14

fce uninstall

Remove all local config + credentials

Any

15

fce version

Show version info

Any

16

fce help

Full command reference

Any

Keychain-backed secure storage · MIT License

Explore Full DocumentationAutomation Guide
[ 06 / 07 ]·CI / CD

Built for pipelines

Skip the keychain in CI by setting the FCE_API_KEY environment variable. The CLI reads it automatically with zero extra config.

  • GitHub Actions
  • GitLab CI/CD
  • CircleCI
  • Jenkins
  • Any shell-capable runner

GitHub Actions example

yaml
- name: Get OTP via fce
  env:
    FCE_API_KEY: ${{ secrets.FCE_API_KEY }}
  run: |
    INBOX=$(fce inbox add random)
    # trigger your app to send email to $INBOX
    OTP=$(fce otp $INBOX)
    echo "OTP: $OTP"

fce CLI · MIT License · FreeCustom.Email · v0.1.12