griptape-cli 0.4.0

CLI for the Griptape Framework and Cloud

griptape-cli

CLI for the Griptape Framework and Cloud.

Prerequisites

CLI cloud commands require a Griptape Cloud account.

Quick Start

1. Install griptape-cli

   pipx install griptape-cli
   

2. Verify installation

   gt --help
   

Griptape Cloud

Configure the Cloud:

poetry run gt cloud configure

Use the cloud command to make API calls:

poetry run gt cloud list-organizations

Create an App from the template using the app command:

poetry run gt app new --directory ~/workplace demo_app

Test an App locally:

poetry run gt app run --directory ~/workplace/demo_app --arg "what is griptape?" --init-param "key" "value"

Create an App on the Cloud:

poetry run gt cloud create-app --name "Demo App"

Create a Deployment for the App on the Cloud using the App ID:

poetry run gt cloud create-deployment --app-id 12345678-9e29-4759-b357-dc513821c5b2 --directory ~/workplace/demo_app

Run an App on the Cloud using the App ID:

poetry run gt cloud run --app-id 12345678-9e29-4759-b357-dc513821c5b2 --arg "what is griptape?" --init-param "key" "value"

Documentation

Please refer to Griptape Docs

Development

poetry install
poetry run gt

Tests

poetry run pytest

Contributing

Thank you for considering contributing to Griptape! Before you start, please read the following guidelines.

Submitting Issues

If you have identified a bug, want to propose a new feature, or have a question, please submit an issue through our public issue tracker. Before submitting a new issue, please check the existing issues to ensure it hasn't been reported or discussed before.

Versioning

Griptape CLI is in constant development and its APIs and documentation are subject to change. Until we stabilize the API and release version 1.0.0, we will use minor versions (i.e., x.Y.z) to introduce features and breaking features, and patch versions (i.e., x.y.Z) for bug fixes.

License

Griptape CLI is available under the Apache 2.0 License.