Metadata-Version: 2.1
Name: cranecloud
Version: 1.0.0
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
Requires-Dist: configparser ==6.0.0
Provides-Extra: dev
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'

# Cranecloud CLI Client

Cranecloud CLI client is a command line tool for interacting with Cranecloud.

## Basic Commands

### Authentication and Account Management

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

   ```bash
   cranecloud auth login
   ```

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

   ```bash
   cranecloud auth logout
   ```

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

   ```bash
   cranecloud auth user
   ```

### 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 ...
   ```

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>
   ```

### Configuration Management

1. **List Config:** Show a list of config available for the app.

   ```bash
   cranecloud config get-config
   ```

2. **Set current project to use:** This is projects apps commands will default to.

   ```bash
   cranecloud projects use-project <project_id>
   ```

3. **Set current cluster to use:** This is cluster projects commands will default to.

   ```bash
   cranecloud projects use-project <cluster_id>
   ```

### App Commands

1. **Deploy App:** Initiate a app .

   ```bash
   cranecloud apps deploy
   ```

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

   ```bash
   cranecloud apps list 
   ```

3. **Update App:** Update app information.

   ```bash
   cranecloud apps update  <app_id>
   ```

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

   ```bash
   cranecloud apps info  <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
   ```
