Metadata-Version: 2.1
Name: griptape-cli
Version: 0.1.0
Summary: CLI for the Griptape Framework and Cloud
Home-page: https://github.com/griptape-ai/griptape-cli
License: Apache 2.0
Author: Griptape
Author-email: hello@griptape.ai
Requires-Python: >=3.9,<3.12
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: attrs (>=23.1.0,<24.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: cookiecutter (>=2.1.1,<3.0.0)
Requires-Dist: griptape
Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
Requires-Dist: stringcase (>=1.2.0,<2.0.0)
Project-URL: Repository, https://github.com/griptape-ai/griptape-cli
Description-Content-Type: text/markdown

# Griptape CLI

CLI for the Griptape Framework and Cloud.

## Can I Just Install the CLI?

Sure!

1. Install [pipx](https://github.com/pypa/pipx)
   ```
   python3 -m pip install --user pipx
   ```
1. Run:
   ```shell
   python3 -m pipx install git+ssh://git@github.com/griptape-ai/griptape-cli.git
   ```
1. Verify installation
   ```
   gt --help
   ```

## Development

```shell
poetry install
poetry run gt
```

## Tests

```shell
poetry run pytest
```

## Griptape Cloud

Set environment variables:

```shell
export GRIPTAPE_CLOUD_API_KEY=<api_key>
```

Note: You can create an API Key using the [frontend](https://cloud.griptape.ai/).

To override the Griptape Cloud endpoint used, set the following environment variable:

```shell
export GRIPTAPE_CLOUD_ENDPOINT_URL="https://<endpoint>"
```

Configure the Cloud:

```shell
poetry run gt cloud configure
```

Use the cloud command to make API calls:

```shell
poetry run gt cloud list-organizations
```

Create an App from the template using the app command:

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

Test an App locally:

```shell
poetry run gt app run --directory ~/workplace/demo_app --arg "what is griptape?"
```

Create an App on the Cloud:

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

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

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

