Metadata-Version: 2.4
Name: codex-aws-helper
Version: 0.3.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Rust
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
License-File: LICENSE
License-File: THIRD_PARTY_NOTICES.md
Summary: A CLI and local Codex plugin for AWS connections, Bedrock models, and configuration
Keywords: aws,bedrock,codex,mcp,cli
Author: mccartnick
License-Expression: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://pypi.org/project/codex-aws-helper/
Project-URL: Issues, https://github.com/mccartnick/codex-aws-helper/issues
Project-URL: Repository, https://github.com/mccartnick/codex-aws-helper

# AWS Helper for Codex

Connect Codex to Amazon Bedrock without editing configuration files by hand.

AWS Helper walks you through choosing an AWS connection, finding a model, and saving the settings Codex needs. Use it in your terminal or ask Codex to guide you through a conversation.

**v0.3.0 · MIT licensed**

## What it helps with

- **Understand your connection.** See the AWS profile and region configured for Codex, and where credentials come from.
- **Find a model.** Browse Bedrock models for your AWS profile and region.
- **Configure Codex.** Answer guided questions, review changes before saving, and undo them if needed.

## Get started

You'll need [uv](https://docs.astral.sh/uv/getting-started/installation/), Codex with its `codex` plugin commands, and AWS CLI v2.22+ for AWS requests.

```sh
uv tool install codex-aws-helper
codex-aws-helper plugin install
```

The package includes the helper and its plugin. Prebuilt wheels cover Apple Silicon and Intel Macs, plus Linux on ARM64 and x86-64. Wheel installation needs no Rust compiler, repository checkout, or GitHub login. Python 3.9+ is required by the package installer.

Using pip instead? Run `python -m pip install codex-aws-helper` in an activated virtual environment, then run the same `plugin install` command. See the [installation guide](docs/installation.md) for platform requirements and other options.

## Ask Codex

Start a **new Codex task**, then try:

> Which AWS profile and region is Codex configured to use?
>
> Show me the Bedrock models for my development profile in us-west-2.
>
> Help me choose a model and set up Codex to use it.

Codex asks for the details it needs and shows the proposed configuration changes before saving.

## Use it in your terminal

```sh
codex-aws-helper
```

The menu offers guided setup, a dashboard, and tools for checking an existing connection. During setup, choose your AWS connection, region, and model, then review the changes before saving.

## Update

```sh
uv tool upgrade codex-aws-helper
codex-aws-helper plugin install
```

Run `plugin install` again after upgrading or moving the helper. It refreshes the executable path and plugin files while preserving existing Codex settings and tool restrictions.

## Before you try it

Sign-in stays in AWS CLI or your browser; you don't need to paste secret keys into chat. Saved settings take effect in new Codex sessions. Optional model tests use your AWS account and may incur normal Bedrock charges.

AWS integration is still a preview. macOS has the most runtime validation; Linux wheels have installation and synthetic test coverage. Automatic desktop launch is macOS-only and accepts specific inspected Codex builds. Model listings do not prove invocation access or native Codex compatibility, and Runtime configuration remains disabled. You can preview or save settings without using the desktop launcher.

To remove the plugin, run `codex-aws-helper plugin uninstall` before `uv tool uninstall codex-aws-helper`. AWS credentials, provider settings, and recovery history remain available.

## Learn more

- [Installation and troubleshooting](docs/installation.md) — pip, Cargo, local packages, and plugin setup.
- [Sharing the plugin](docs/plugin-distribution.md) — install without a checkout and understand the OpenAI marketplace path.
- [Compatibility](docs/compatibility.md) — supported flows and measured limits.
- [Terminal guide](docs/terminal-guide.md) — sign-in, configuration, and everyday commands.
- [Contributing](CONTRIBUTING.md) — development, testing, and packaging.
- [Codex development setup](docs/codex-remote-setup.md) and [PDF cheat sheet](output/pdf/codex-remote-development-cheatsheet.pdf) — remote hosts, worktrees, hooks, and project guidance.

The source distribution on [PyPI](https://pypi.org/project/codex-aws-helper/#files) includes the source and detailed guides. GitHub guides and issues require repository access while the repository is private.

An independent community project, distributed under the [MIT license](LICENSE).

