athul/fcc

fcc - A CLI for Frappe Cloud

This is very early and highly WIP. Anything can change :)

If you want to try this, then

1. Clone this repo and cd to it
2. Execute pip install -e .
3. use fcc

Usage

Login

$ fcc login
Frappe Cloud Username: 
Frappe Cloud Password:

Enter your login credentials here and fcc will login to your account and generate an API key. This API key will be stored in the ~/.config/fcc/.fcc file.

Verifying

$ fcc getme
{'message': {'user': '[email protected]', 'team': '[email protected]'}}

getme returns your username and current-team associated with your account

Sites

$ fcc sites
Usage: fcc sites [OPTIONS] COMMAND [ARGS]...

  Access Sites and Execute actions on Sites

Options:
  --help  Show this message and exit.

Commands:
  list  List the sites

List Sites

$ fcc sites list

                     All Sites of [email protected]                      
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ Site Name               ┃ Status ┃ Version ┃ RegionCreated ┃          ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
│ athul-test.frappe.cloud │ Active │ Nightly │ Mumbai        │ 7 months │
└─────────────────────────┴────────┴─────────┴───────────────┴──────────┘

You will be given a menu to select your team for listing your sites

Benches

$ fcc bench
Usage: fcc bench [OPTIONS] COMMAND [ARGS]...

  Access Benches and execute actions on Benches

Options:
  --help  Show this message and exit.

Commands:
  deploy  Deploy a new version of the Bench
  list    List all Private benches under a team
  ssh     Login to Bench
  update  Update a Bench

List Benches

$ fcc bench list
                               All Benches of [email protected]                                
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ Bench Title       ┃ Status ┃ Number of Sites ┃ Total Apps ┃ Version ┃ Bench Name ┃ Created  ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ Self Hosted Bench │ Active │ 1               │ 2          │ Nightly │ bench-4219 │ 7 months │
└───────────────────┴────────┴─────────────────┴────────────┴─────────┴────────────┴──────────┘

You'll be prompted to select the team.

Deploy Bench

$ fc bench deploy
fcc bench deploy --help
Usage: fcc bench deploy [OPTIONS]

  Deploy a new version of the Bench

Options:
  --team TEXT   Team owning the Private Bench
  --bench TEXT  The Name of the bench. eg: bench-4219
  --help        Show this message and exit.

SSH to Bench

$  fcc bench ssh --help
Usage: fcc bench ssh [OPTIONS]

  Login to Bench

Options:
  --team TEXT  Team owning the Private Bench
  --site TEXT  The Frappe Cloud Site
  --help       Show this message and exit.

---

I want to dedicate this project to Abraham Raji, who was my dearest friend, an awesome engineer and a great human. He passed away due to a Kayaking accident on September 13th 2023.