Quick Start

1. Describe the IAM user in a JSON config file:

{
    "aws_region": "us-east-1",
    "iam_user_name": "gh-ci-my-project",
    "policy_document": {
        "Version": "2012-10-17",
        "Statement": [
            {"Effect": "Allow", "Action": ["s3:ListBucket"], "Resource": "*"}
        ]
    },
    "path_access_key_json": "my_access_key.json",
    "github_user_name": "my-github-user",
    "github_repo_name": "my-project"
}

2. Create the IAM user, its access key, and the GitHub secrets. AWS credentials come from your AWS profile; the GitHub token from the GITHUB_TOKEN environment variable:

uvx simple-gh-aws-creds setup --config config.json --aws_profile my-profile

3. Use the secrets in a workflow:

jobs:
  aws-job:
    runs-on: ubuntu-latest
    env:
      AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    steps:
      - run: aws sts get-caller-identity

Read more:

• Quick Start: the full walk-through, with prerequisites.

• How It Works: what gets created, and the security trade-off.

• CLI Reference: the config file and every command.

• Python API: the same, from Python.

• Troubleshooting: common errors and how to fix them.

Install

simple_gh_aws_creds is released on PyPI. Run the command line tool without installing it:

$ uvx simple-gh-aws-creds --help

Or install it, for the command line tool and the Python API:

$ pip install simple-gh-aws-creds

To upgrade to latest version:

$ pip install --upgrade simple-gh-aws-creds

Use with AI Coding Agents

This repo ships an Agent Skill that documents the public API of simple_gh_aws_creds, so an AI coding agent such as Claude Code can use the library without reading its source. It lives in .claude/skills/pypi-simple_gh_aws_creds. To use it in your project, copy it into your project’s .claude/skills/ folder. Run this from your project’s root:

$ git clone --depth 1 https://github.com/MacHu-GWU/simple_gh_aws_creds-project.git /tmp/simple_gh_aws_creds-project
$ mkdir -p .claude/skills
$ cp -R /tmp/simple_gh_aws_creds-project/.claude/skills/pypi-simple_gh_aws_creds .claude/skills/