Metadata-Version: 2.1
Name: cranecloud-test
Version: 0.0.1
Summary: Cranecloud CLI client
Author-email: cranecloud <allan@cranecloud.io>
Project-URL: Homepage, https://github.com/crane-cloud/cranecloud-cli
Project-URL: Issues, https://github.com/crane-cloud/cranecloud-cli/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Click
Requires-Dist: requests
Requires-Dist: keyring==24.3.0
Requires-Dist: tabulate
Requires-Dist: colorama
Requires-Dist: Pygments
Requires-Dist: rich
Requires-Dist: python-dotenv
Requires-Dist: urllib3==2.1.0
Requires-Dist: toml==0.10.2
Provides-Extra: dev
Requires-Dist: twine; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# Cranecloud CLI Cleint

Cranecloud CLI client

### Setup

1. **Create** and activate a virtual environment

   ```bash
   python3 -m venv venv
   ```

2. **Install:** Run the Cranecloud CLI client setup.

   ```bash
   pip install --editable .
   ```

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

   ```bash
   export API_BASE_URL=""
   ```

4. Run Cranecloud commands

   ```bash
   cranecloud --help
   ```

## Basic Commands

### Authentication and Account Management

1. **Login:** Authenticate the user with their credentials.

   ```bash
   cranecloud login
   ```

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

   ```bash
   cranecloud logout
   ```

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

   ```bash
   cranecloud user info
   ```

### Project Management

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

   ```bash
   cranecloud projects list
   ```

2. **Create Project:** Create a new project.

   ```bash
   cranecloud projects create --name "ProjectName"
   ```

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

   ```bash
   cranecloud projects delete --id <project_id>
   ```

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

   ```bash
   cranecloud projects info --id <project_id>
   ```

### App Commands

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

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

2. **List Apps:** Show apps within a project.

   ```bash
   cranecloud apps list --project-id <project_id>
   ```

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

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

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

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

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

   ```bash
   cranecloud projects delete --id <project_id>
   ```

### Other Useful Commands

1. **Help Information:** Show manual.

   ```bash
   cranecloud help
   ```

2. **Support:** Contact support or report issues.

   ```bash
   cranecloud support
   ```
