A CLI companion tool for managing Holoforge applications
Project description
Holoforge CLI
This is the command-line interface (CLI) for Holoforge, a tool that helps you manage and deploy serverless applications on AWS.
Getting Started
Prerequisites:
- Python 3.6 or later
- AWS CLI configured with proper credentials
samCLI installed (pip install aws-samcli)
Installation:
There is no separate installation for the Holoforge CLI. It seems to be part of a larger codebase.
Usage
The CLI supports two main commands:
init: Initializes a new SAM project with basic configuration.pull: Pulls code for an existing application from a remote location (likely AWS API Gateway) and configures the local SAM project.
init command:
holo init <project-name>
This command creates a new SAM project named <project-name> with a basic structure and configuration for a Python 3.12 application.
pull command:
holo pull <app-id>
This command pulls the code for an application with the ID <app-id> from a remote location and configures the local SAM project. It performs the following steps:
- Authenticates with AWS Cognito using the credentials stored in a configuration file (~/.hfcredentials).
- Retrieves the application details from the API Gateway using the provided
<app-id>. - Extracts the YAML template and Lambda function code from the response.
- Saves the YAML template to a file named
template.yamlin the current working directory. - Creates directories for each Lambda function and saves the function code to the corresponding
.pyfile in the respective directory. - (Optional) Saves any requirements specified for the Lambda functions to a
requirements.txtfile in the corresponding function directory.
Storing Credentials:
The CLI stores your AWS credentials in a configuration file named .hfcredentials in your home directory. If the file doesn't exist, the first time you run holo pull, you will be prompted to enter your username and password.
Clear Screen Animation (Optional):
The code includes functionality for displaying an animation during some operations (commented out). You can uncomment the relevant sections if you want to enable the animations.
Caveats and Limitations
- The code assumes a specific structure for the response received from the API Gateway.
- Error handling is limited.
- The
pullcommand logic for retrieving and processing application code needs to be implemented based on the actual logic used by Holoforge.
Contributing
If you want to contribute to Holoforge, refer to the project's contribution guidelines (if available).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file HoloforgeAI-CLI-0.1.0.tar.gz.
File metadata
- Download URL: HoloforgeAI-CLI-0.1.0.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cfa43d0460b0b38d1e7c1a6b8e2eb928749011003c49279b2a7a73571144dbad
|
|
| MD5 |
c8780a15aa6a429782226a6bdd622be9
|
|
| BLAKE2b-256 |
f14c7dbcdad18ae5d8df6321c955c7e421aa5f690f80b85f8a6dd7436c9b3fa9
|
File details
Details for the file HoloforgeAI_CLI-0.1.0-py3-none-any.whl.
File metadata
- Download URL: HoloforgeAI_CLI-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4f6d98fea07d174e90817f3e0bdefa05a25f02b5b5a4a41e88c6950bffbf3de
|
|
| MD5 |
6b1a8fcf58f89adb6845c55ca1cff611
|
|
| BLAKE2b-256 |
cdb88b6664af2927b97afbb5a056725527a34d3f65a84a89a1f465c83491c720
|