MuffinBite Docs

Commands

MuffinBite exposes a small, deliberate set of commands. Each command does one thing clearly and requires explicit user action.

You can view all available commands at any time by typing:

bite> help

Available MuffinBite commands:

    build - Create the necessary directories and files for the working of the project

    camp - Maintains campaign
        Example:
            camp --create                   (creates new campaign)
            camp --show   'campaign_name'   (shows a specific campaign)
            camp --delete 'campaign_name'   (delete a specific campaign)
            camp --list                     (list all the campaigns)

    send - Sends emails
        Example:
            send --test (sends emails from test data)
            send --real (sends emails from real data)

    config - Configure settings.
        Example:
            config --user-name name                             (resets user name)
            config --user-email firstname.lastname@example.com  (resets the user email)
            config --service-provider-name provider_name        (resets service provider name)
            config --service-provider-server server_address     (resets service provider server address)
            config --service-provider-login login               (resets service provider login ID)
            config --service-provider-port 000                  (resets service provider port number)
            config --signature "<html>"                         (add signature to all the outgoing mails)
            config --signature-on                               (turn signatures ON)
            config --signature-off                              (turn signatures OFF)
            config --time-delay 0.00                            (time gap between two emails)
            config --show                                       (shows the current configurations)
            config --debug True/False                           (switches debug mode for error logs)

    exit - Exit the MuffinBite

    reset - Deletes the config file

    help - Shows all the available commands and their uses

    Use !<command> for direct shell commands like 'ls', 'clear', 'pwd', etc.

    Shell commands (!command):
    - Uses the system shell
    - Linux/macOS: bash or zsh
    - Windows: cmd.exe or PowerShell
    - Command syntax differs by OS

    Examples:
    Linux/macOS: !ls, !clear
    Windows: !dir, !cls

bite>

1. build

Initializes the required folder structure for MuffinBite in the current directory. This command must be run before creating campaigns or sending emails.

bite> build

Checking for directories...

    Created: Attachments
    Created: DataFiles
    Created: EmailStatus
    Created: Templates
    Created: Campaigns

Choose your email provider:
  1. Gmail (recommended)
  2. Other SMTP service
Provider (enter 1 or 2): 1

Gmail token will be generated separately via OAuth flow.

User configuration saved successfully!

Setup completed successfully !!

bite>

2. camp

Manages email campaigns. A campaign defines the subject line, template, attachments, and CC/BCC configuration.

# Create a campaign
bite> camp --create

# Show campaign details
bite> camp --show welcome_campaign

# List all campaigns
bite> camp --list

# Delete a campaign
bite> camp --delete welcome_campaign

3. send

Sends emails immediately using the active campaign. MuffinBite does not schedule or queue emails.

# Send test emails
bite> send --test

# Send real emails
bite> send --real

4. config

Configures user identity, provider settings, signatures, debug mode, and email sending behavior.

bite> config --user-name "John Doe"
bite> config --user-email john@example.com
bite> config --time-delay 1.5
bite> config --signature "<p>Regards,<br/>John</p>"
bite> config --signature-on
bite> config --show

--user-name: Display name used in emails
--user-email: Sender email address
--time-delay: Delay between emails (minimum 0.42s)
--signature: Global HTML signature
--debug: Enable detailed error logging

Note: Gmail users do not need to configure SMTP server, login, or port.

5. reset

Deletes the configuration file stored in your system. Use this if you want a clean setup.

bite> reset

6. exit

Exits the MuffinBite CLI.

bite> exit

Shell Commands (!command)

You can execute system shell commands directly from the CLI using !. The shell used depends on your operating system.

# Linux / macOS
!ls
!clear

# Windows
!dir
!cls

Command syntax varies by OS. MuffinBite does not translate shell commands.

Usage & Examples Developer