Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 1 addition & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,6 @@
# 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
```
Cranecloud CLI client is a command line tool for interacting with Cranecloud.

## Basic Commands

Expand Down
121 changes: 120 additions & 1 deletion cranecloud.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,6 +1,125 @@
Metadata-Version: 2.1
Name: cranecloud
Version: 0.1.0
Version: 0.0.3
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 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 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
```
16 changes: 12 additions & 4 deletions cranecloud.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
LICENSE
README.md
pyproject.toml
setup.py
app/__init__.py
app/commands/__init__.py
app/commands/user_management.py
cranecloud.egg-info/PKG-INFO
cranecloud.egg-info/SOURCES.txt
cranecloud.egg-info/dependency_links.txt
cranecloud.egg-info/entry_points.txt
cranecloud.egg-info/requires.txt
cranecloud.egg-info/top_level.txt
cranecloud.egg-info/top_level.txt
src/__init__.py
src/config.py
src/cranecloud/__init__.py
src/cranecloud/commands/__init__.py
src/cranecloud/commands/apps.py
src/cranecloud/commands/clusters.py
src/cranecloud/commands/projects.py
src/cranecloud/commands/test_user_management.py
src/cranecloud/commands/user_management.py
src/cranecloud/helpers/__init__.py
2 changes: 1 addition & 1 deletion cranecloud.egg-info/entry_points.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[console_scripts]
cranecloud = app:cli
cranecloud = src.cranecloud:cli
13 changes: 13 additions & 0 deletions cranecloud.egg-info/requires.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
Click
requests
keyring==24.3.0
tabulate
colorama
Pygments
rich
python-dotenv
urllib3==2.1.0
toml==0.10.2

[dev]
twine
pip-tools
pytest
2 changes: 1 addition & 1 deletion cranecloud.egg-info/top_level.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
app
src
151 changes: 151 additions & 0 deletions cranecloud_test.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
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
```
20 changes: 20 additions & 0 deletions cranecloud_test.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
LICENSE
README.md
pyproject.toml
setup.py
cranecloud_test.egg-info/PKG-INFO
cranecloud_test.egg-info/SOURCES.txt
cranecloud_test.egg-info/dependency_links.txt
cranecloud_test.egg-info/entry_points.txt
cranecloud_test.egg-info/requires.txt
cranecloud_test.egg-info/top_level.txt
src/__init__.py
src/config.py
src/cranecloud/__init__.py
src/cranecloud/commands/__init__.py
src/cranecloud/commands/apps.py
src/cranecloud/commands/clusters.py
src/cranecloud/commands/projects.py
src/cranecloud/commands/test_user_management.py
src/cranecloud/commands/user_management.py
src/cranecloud/helpers/__init__.py
1 change: 1 addition & 0 deletions cranecloud_test.egg-info/dependency_links.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

2 changes: 2 additions & 0 deletions cranecloud_test.egg-info/entry_points.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[console_scripts]
cranecloud = src.cranecloud:cli
Loading