Cranecloud CLI Cleint

Cranecloud CLI client

Setup

1. Create and activate a virtual environment

   python3 -m venv venv
   

2. Install: Run the Cranecloud CLI client setup.

   pip install --editable .
   

3. Add API_BASE_URL that points to cc backend to your .env file

   export API_BASE_URL=""
   

4. Run Cranecloud commands

   cranecloud --help
   

Basic Commands

Authentication and Account Management

1. Login: Authenticate the user with their credentials.

   cranecloud login
   

2. Logout: Log out the user, clearing the stored credentials.

   cranecloud logout
   

3. User Information: Retrieve information about the logged-in user.

   cranecloud user info
   

Project Management

1. List Projects: Show a list of projects available in the user's account.

   cranecloud projects list
   

2. Create Project: Create a new project.

   cranecloud projects create --name "ProjectName"
   

3. Delete Project: Delete a project by ID or name.

   cranecloud projects delete --id <project_id>
   

4. Project Details: View detailed information about a project.

   cranecloud projects info --id <project_id>
   

App Commands

1. Deploy App: Initiate a app to a specific environment.

   cranecloud apps --project-id <project_id> --environment <env_name>
   

2. List Apps: Show apps within a project.

   cranecloud apps list --project-id <project_id>
   

3. Rollback App: Roll back to a previous app version.

   cranecloud apps rollback --project-id <project_id> --app-id <app_id>
   

4. App Details: View detailed information about a specific app.

   cranecloud apps info --project-id <project_id> --app-id <app_id>
   

5. Delete App: Delete a app by ID or name.

   cranecloud projects delete --id <project_id>
   

Other Useful Commands

1. Help Information: Show manual.

   cranecloud help
   

2. Support: Contact support or report issues.

   cranecloud support