https://github.com/dustinblackman/cf-alias

Create Cloudflare email alias' directly from your terminal or Alfred.
https://github.com/dustinblackman/cf-alias

alfred cloudflare email rust

Last synced: 11 months ago
JSON representation

Create Cloudflare email alias' directly from your terminal or Alfred.

• Host: GitHub
• URL: https://github.com/dustinblackman/cf-alias
• Owner: dustinblackman
• License: mit
• Created: 2022-09-19T00:16:41.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T11:50:30.000Z (over 2 years ago)
• Last Synced: 2023-11-07T12:38:17.477Z (over 2 years ago)
• Topics: alfred, cloudflare, email, rust
• Language: Rust
• Homepage:
• Size: 611 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![cf-alias](.github/banner.jpg)

[![Release](https://img.shields.io/github/v/release/dustinblackman/cf-alias)](https://github.com/dustinblackman/cf-alias/releases)

> Create Cloudflare email alias' directly from your terminal or Alfred.

- [Overview](#Overview)

- [Install](#Install)

  - [Source](#source)

- [Usage](#Usage)

  - [CLI](#cli)

  - [Alfred](#alfred)

## Overview

Create and manage CloudFlare email alias's easily to reduce the barrier in creating unique emails per online account you own. You can list all alias to easily copy to clipboard, create unique alias of your choosing, or generate random ones!

This was done quickly and just for fun, and is using an undocumented Cloudflare API. Bugs are expected!

![screenshot1](./.github/screenshots/1.jpg)

```

cf-alias v0.1.9

CLI interface for Cloudflare Email Routing

USAGE:

    cf-alias 

OPTIONS:

    -h, --help       Print help information

    -V, --version    Print version information

SUBCOMMANDS:

    alfred        Commands for the Alfred extension

    completion    Generates shell completions

    create        Creates a new forwarding email

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

    list          List existing email routes.

```

## Install

### Source

```sh

git clone https://github.com/dustinblackman/cf-alias.git

cd cf-alias

cargo install --path .

```

## Usage

Create a configuration file in `$HOME/.cf-alias.json` with the following keys. You can find values for each in the

Cloudflare dashboard.

```json

{

  "cloudflare_account_id": "cloudflare-acccount-id-here",

  "cloudflare_forward_email": "mygmail@gmail.com",

  "cloudflare_root_domain": "mydomain.com",

  "cloudflare_token": "cloudflare-api-token",

  "cloudflare_zone": "cloud-zone-id-for-mydomain.com"

}

```

### CLI

- `cf-alias list` to list existing forwarders.

- `cf-alias create --email-prefix github` to create a email fowarder as `github@mydomain.com`

- `cf-alias create --random` to create a randomly generated email forwarder.

### Alfred

Install the Alfred extension by

[downloading](https://github.com/dustinblackman/cf-alias/blob/master/alfred/mx.alfredworkflow?raw=true) the extension, and dragging it in to Alfred to install. Use `mx` as a prefix to bring up all the available commands.

![screenshot1](./.github/screenshots/1.jpg)

You can create a specific email forwarder with `mx create MY-NAME`.

![screenshot2](./.github/screenshots/2.jpg)

cf-alias can also generate you a random email forwarder by running `mx create random`.

![screenshot3](./.github/screenshots/3.jpg)