https://github.com/levonium/addy-io-cli
A small command line app for interacting with addy.io
https://github.com/levonium/addy-io-cli
Last synced: 12 months ago
JSON representation
A small command line app for interacting with addy.io
- Host: GitHub
- URL: https://github.com/levonium/addy-io-cli
- Owner: levonium
- Created: 2025-03-23T11:41:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-23T11:43:35.000Z (about 1 year ago)
- Last Synced: 2025-06-25T03:54:51.827Z (12 months ago)
- Language: PHP
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# addy.io cli
A small command line app for interacting with [addy.io](https://addy.io).
Built with [Laravel](https://github.com/laravel/laravel) using [prompts](https://github.com/laravel/prompts).
## Usage
1. clone the repository
```shell
git clone [repository-url]
cd addy-io-cli
```
2. install dependencies
```shell
composer install
```
3. add your [addy.io](https://app.addy.io/settings/api) API key to `.env`
```shell
ADDY_IO_API_KEY="addy_io_KEY_HERE"
```
4. test it by running
```shell
php artisan alias:count
```
### Available commands
get alias count:
```shell
php artisan alias:count
```
list aliases:
```shell
php artisan alias:list
```
search aliases:
```shell
php artisan alias:search
```
list interactively filtered list of aliases:
```shell
php artisan alias:all
```
create an alias:
```shell
php artisan alias:create
```
show an alias:
```shell
php artisan alias:show
```
update an alias:
```shell
php artisan alias:update
```
update recipients of an alias:
```shell
php artisan alias:update-recipients
```
activate an alias:
```shell
php artisan alias:activate
```
deactivate an alias:
```shell
php artisan alias:deactivate
```
delete an alias:
```shell
php artisan alias:delete
```
restore an alias:
```shell
php artisan alias:restore
```
forget an alias:
```shell
php artisan alias:forget
```
list recipients:
```shell
php artisan recipient:list
```
list domains:
```shell
php artisan domain:list
```
list usernames:
```shell
php artisan username:list
```