This project uses Mise (https://mise.jdx.dev/). At the moment, there is no dedicated development container, thus you need to configure your local development environment following the steps described below.
- Mise >= 2026.2.4
| Action | |
|---|---|
| Open the repository. | As you are reading this file from the repo, you are probably already there. |
| Using the "fork" button in the upper right, fork the repo into your account. | Some git/GitHub expertise is assumed. |
| Clone forked repo to your local development environment. | If you wish to work off a branch in your repository, create and clone that branch. You will create a PR back to main in the agent-plugins repository eventually, you can do that from fork/main or fork/branch |
cd agent-plugins |
This is the home directory of the repo and where you will open your text editor, run builds, etc. |
code . |
Opens the project in VSCode. You can use the editor of your choice, just adapt this step to your specific use case. |
mise install |
This command will install the tools required for the project and environmental variables |
This project uses Claude Code plugins for development workflows. The project-level .claude/settings.json pre-configures enabled plugins via enabledPlugins, but you must first register the marketplace(s) it references.
Run this once inside a Claude Code session:
/plugin marketplace add awslabs/agent-pluginsAfter adding the marketplace, the plugins listed in .claude/settings.json will activate automatically for this project.
The project-level attribution.pr setting automatically appends the required contributor statement to pull request descriptions created by Claude Code, so the contributorStatement CI check passes without manual copy-paste.
This project also includes Codex plugin packaging for local marketplace-based
testing. The repository provides a Codex marketplace at
.agents/plugins/marketplace.json and Codex plugin manifests at
plugins/*/.codex-plugin/plugin.json.
Open the repository in Codex so it can discover the repo-local marketplace, then restart Codex if the marketplace does not appear immediately.
After restart, the Agent Plugins for AWS marketplace should appear in the
plugin picker and you can install any of the local AWS plugins from there.
If you update Claude plugin manifests or marketplace metadata, regenerate the Codex files with:
python3 tools/generate_codex_manifests.pyThis keeps the Codex marketplace and per-plugin Codex manifests aligned with the Claude source manifests.
| Action | Explanation |
|---|---|
(optional)git checkout -b your-branch-name |
If you're working in a different branch than main in your forked repo and haven't changed your local branch, now is a good time to do so. |
| Do all your code editing | Work with your AI assistant to edit the code, validate and verify. |
mise build |
This is the build command for the project. It will compile and run all the quality gates, and run the unit and integration tests. If you make any substantive changes to the code, you will almost certainly see some or all of the tests fail. Before you commit, you should run a full build. |
This repository uses gitleaks to detect secrets and sensitive information in the codebase.
If gitleaks reports a false positive (e.g., example API keys in documentation, test fixtures), you can add it to the baseline file to suppress future warnings.
-
Run gitleaks locally to generate the baseline:
gitleaks git --config=.gitleaks.toml --report-format=json . > .gitleaks-baseline.json
-
Review the generated file to ensure only legitimate false positives are included.
-
Commit the updated
.gitleaks-baseline.jsonfile.
Custom rules and allowlists are defined in .gitleaks.toml. Common customizations include:
- Excluding paths (vendor directories, generated files)
- Allowlisting specific patterns or files
- Adding custom secret detection rules