grc-engineering-suite
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 13 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/GRCEngClub/claude-grc-engineering with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/GRCEngClub/claude-grc-engineering'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/grcengclub-claude-grc-engineering)HTML
<a href="/listings/grcengclub-claude-grc-engineering"><img src="/api/listings/grcengclub-claude-grc-engineering/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Inside Claude Code:
/plugin marketplace add GRCEngClub/claude-grc-engineering /plugin install grc-engineer@grc-engineering-suite
For a first run without cloud credentials, use GitHub as the evidence source:
/plugin install github-inspector@grc-engineering-suite /plugin install soc2@grc-engineering-suite /github-inspector:setup /github-inspector:collect --scope=@me /grc-engineer:gap-assessment SOC2 --sources=github-inspector
Full walkthrough: [docs/QUICKSTART.md](docs/QUICKSTART.md).
Using Claude Desktop or Claude Cowork instead of Claude Code? Start with [docs/CLAUDE-COWORK.md](docs/CLAUDE-COWORK.md). Anthropic's security and compliance posture is documented at [trust.anthropic.com](https://trust.anthropic.com/), and the Claude Cowork third-party platform guide is here: [Claude Desktop on third-party platforms](https://claude.com/docs/cowork/3p/overview).
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 443 lines
- {
- "name": "grc-engineering-suite",
- "owner": {
- "name": "GRC Engineering Club",
- "url": "https://grcengclub.com"
- },
- "metadata": {
- "description": "GRC Engineering Plugin Suite - Tools for auditors, internal teams, TPRM, and framework-specific compliance",
- "version": "0.1.0",
- "pluginRoot": "./plugins"
- },
- "plugins": [
- {
- "name": "vault-kv",
- "source": "./plugins/connectors/vault-kv",
- "description": "Operator-only Vault KV runtime injection into a trusted local process.",
- "version": "0.1.0"
- },
- {
- "name": "gcp-secret-metadata",
- "source": "./plugins/connectors/gcp-secret-metadata",
- "description": "GCP Secret Manager name inventory and operator-only runtime injection.",
- "version": "0.1.0"
- },
- {
- "name": "grc-engineer",
- "source": "./plugins/grc-engineer",
- "description": "Maps IaC to compliance controls, generates policies, collects evidence, reviews PRs",
- "version": "0.1.0"
- },
- {
- "name": "grc-auditor",
- "source": "./plugins/grc-auditor",
- "description": "Evidence review, control validation, and audit workpaper generation for external auditors",
- "version": "0.1.0"
- },
- {
- "name": "grc-internal",
- "source": "./plugins/grc-internal",
- "description": "Policy management, risk registers, and compliance tracking for internal GRC teams",
- "version": "0.1.0"
- },
- {
- "name": "grc-tprm",
- "source": "./plugins/grc-tprm",
- "description": "Vendor assessments, questionnaire analysis, and risk scoring for third-party risk management",
- "version": "0.1.0"
- },
- {
- "name": "grc-reporter",
- "source": "./plugins/grc-reporter",
- "description": "Translate findings, risks, and metrics into narratives leadership reads. Reference implementation of the Reporting category from RFC #38.",
- "version": "0.1.0"
- },
- {
- "name": "grc-loop",
- "source": "./plugins/grc-loop",
- "description": "Iterative GRC automation loops for gap-remediation burndown and quarterly evidence sweeps.",
- "version": "0.1.0"
- },
- {
- "name": "gcp-docs",
- "source": "./plugins/knowledge-sources/gcp-docs",
- "description": "Knowledge source for Google Developer Knowledge API: current Google developer documentation citations for GRC workflows.",
- "version": "0.1.0"
- },
- {
- "name": "teach-me",
- "source": "./plugins/teach-me",
- "description": "Socratic primer + drill plugin for new-to-GRC practitioners. Get up to speed on a framework, control, or role without already knowing it.",
- "version": "0.1.0"
- },
- {
- "name": "academic-research-companion",
- "source": "./plugins/academic-research-companion",
- "description": "Guide a research project through the academic lifecycle — idea, literature, methodology, writing, feedback, publishing, and authorship — with verified sources and a durable tracker.",
- "version": "0.1.0"
- },
- {
- "name": "grc-diagrams",
- "source": "./plugins/grc-diagrams",
- "description": "Editable draw.io diagram patterns for GRC system boundaries, evidence flows, control maps, risk treatment, audits, crosswalks, TPRM, POA&M, data flows, RACI, and operating models.",
- "version": "0.1.0",
- "category": "workflow",
- "tags": [
- "drawio",
- "diagrams",
- "grc",
- "audit",
- "risk",
- "compliance"
- ]
- },
- {
- "name": "soc2",
- "source": "./plugins/frameworks/soc2",
- "description": "SOC 2 Trust Service Criteria expertise and Type I/II assessment support",
- "version": "0.1.0"
- },
- {
- "name": "nist-800-53",
- "source": "./plugins/frameworks/nist-800-53",
- "description": "NIST 800-53 control families and baseline selection (Low/Moderate/High)",
- "version": "0.1.0"
- },
- {
- "name": "iso27001",
- "source": "./plugins/frameworks/iso27001",
- "description": "ISO 27001 Annex A controls and ISMS implementation guidance",
- "version": "0.1.0"
- },
- {
- "name": "fedramp-rev5",
- "source": "./plugins/frameworks/fedramp-rev5",
- "description": "FedRAMP Rev 5 traditional authorization with SSP/SAP/SAR/POA&M and NIST 800-53 controls",
- "version": "0.1.0"
- },
- {
- "name": "fedramp-20x",
- "source": "./plugins/frameworks/fedramp-20x",
- "description": "FedRAMP 20X automated authorization with KSIs, continuous monitoring, and auto-sync from official docs",
- "version": "0.1.0"
- },
- {
- "name": "pci-dss",
- "source": "./plugins/frameworks/pci-dss",
- "description": "PCI DSS v4.0.1 compliance with ROC guidance, SAQ selection, and March 2025 requirements",
- "version": "0.1.0"
- },
- {
- "name": "cmmc",
- "source": "./plugins/frameworks/cmmc",
- "description": "CMMC v2.0 (DoD contractors) with 5 levels and C3PAO assessment prep",
- "version": "0.1.0"
- },
- {
- "name": "hitrust",
- "source": "./plugins/frameworks/hitrust",
- "description": "HITRUST CSF healthcare security with i1/r2 assessments",
- "version": "0.1.0"
- },
- {
- "name": "cis-controls",
- "source": "./plugins/frameworks/cis-controls",
- "description": "CIS Controls v8 baseline security with IG1/IG2/IG3 levels",
- "version": "0.1.0"
- },
- {
- "name": "gdpr",
- "source": "./plugins/frameworks/gdpr",
- "description": "GDPR EU privacy regulation with DPIA and data subject rights",
- "version": "0.1.0"
- },
- {
- "name": "csa-ccm",
- "source": "./plugins/frameworks/csa-ccm",
- "description": "CSA Cloud Controls Matrix with 197 controls and CAIQ support",
- "version": "0.1.0"
- },
- {
- "name": "nydfs",
- "source": "./plugins/frameworks/nydfs",
- "description": "NYDFS 23 NYCRR 500 cybersecurity requirements for financial services",
- "version": "0.1.0"
- },
- {
- "name": "dora",
- "source": "./plugins/frameworks/dora",
- "description": "DORA EU Digital Operational Resilience Act for financial entities",
- "version": "0.1.0"
- },
- {
- "name": "stateramp",
- "source": "./plugins/frameworks/stateramp",
- "description": "StateRAMP state/local government cloud authorization",
- "version": "0.1.0"
- },
- {
- "name": "essential8",
- "source": "./plugins/frameworks/essential8",
- "description": "Essential 8 Australian cyber security strategies with maturity levels",
- "version": "0.1.0"
- },
- {
- "name": "glba",
- "source": "./plugins/frameworks/glba",
- "description": "GLBA Gramm-Leach-Bliley Act for financial institution privacy",
- "version": "0.1.0"
- },
- {
- "name": "us-export",
- "source": "./plugins/frameworks/us-export",
- "description": "US Export Controls: ITAR (defense) + EAR (dual-use commercial) compliance",
- "version": "0.1.0"
- },
- {
- "name": "us-hipaa-security",
- "source": "./plugins/frameworks/us-hipaa-security",
- "description": "HIPAA Security Rule (45 CFR Part 164, Subpart C) for ePHI protection with Administrative, Physical, and Technical Safeguards",
- "version": "0.1.0"
- },
- {
- "name": "pbmm",
- "source": "./plugins/frameworks/pbmm",
- "description": "Canadian PBMM (Protected B Medium Medium) with ITSG-33 controls",
- "version": "0.1.0"
- },
- {
- "name": "ismap",
- "source": "./plugins/frameworks/ismap",
- "description": "Japanese ISMAP government cloud security (ISO 27001/27017/27018)",
- "version": "0.1.0"
- },
- {
- "name": "irap",
- "source": "./plugins/frameworks/irap",
- "description": "Australian IRAP (ISM + Essential Eight) for government cloud",
- "version": "0.1.0"
- },
- {
- "name": "aws-inspector",
- "source": "./plugins/connectors/aws-inspector",
- "description": "GRC connector for AWS: IAM, S3, CloudTrail, EBS compliance checks \u2192 v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "onepassword-connector",
- "source": "./plugins/connectors/onepassword-connector",
- "description": "Run trusted local commands with 1Password secret references and suppressed output.",
- "version": "0.1.0"
- },
- {
- "name": "aws-secrets-inspector",
- "source": "./plugins/connectors/aws-secrets-inspector",
- "description": "GRC connector for AWS Secrets Manager: rotation, customer-managed KMS, resource policy, and access-pattern checks \u2192 v1 finding contract. Hybrid shape supports opt-in secret retrieval to stdout or 0600-permission files.",
- "version": "0.1.0"
- },
- {
- "name": "github-inspector",
- "source": "./plugins/connectors/github-inspector",
- "description": "GRC connector for GitHub: branch protection, secret scanning, Dependabot, code scanning \u2192 v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "gcp-inspector",
- "source": "./plugins/connectors/gcp-inspector",
- "description": "GRC connector for Google Cloud: IAM, Cloud Storage, audit logs, KMS rotation, Compute OS Login \u2192 v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "azure-inspector",
- "source": "./plugins/connectors/azure-inspector",
- "description": "GRC connector for Azure: Entra ID, Storage, Key Vault, Monitor, and Defender for Cloud to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "slack-inspector",
- "source": "./plugins/connectors/slack-inspector",
- "description": "GRC connector for Slack: workspace 2FA, SSO/session, retention, app approvals, and DLP visibility to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "datadog-inspector",
- "source": "./plugins/connectors/datadog-inspector",
- "description": "GRC connector for Datadog: log retention, audit logs, monitor coverage, SSO, and RBAC to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "crowdstrike-inspector",
- "source": "./plugins/connectors/crowdstrike-inspector",
- "description": "GRC connector for CrowdStrike Falcon: sensor coverage, policies, and host-group scoping to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "drata-inspector",
- "source": "./plugins/connectors/drata-inspector",
- "description": "GRC connector for Drata: wraps drata-cli workflows and normalizes compliance posture to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "splunk-inspector",
- "source": "./plugins/connectors/splunk-inspector",
- "description": "GRC connector for Splunk: index retention, RBAC, audit coverage, search ACLs, and auth posture to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "tenable-inspector",
- "source": "./plugins/connectors/tenable-inspector",
- "description": "GRC connector for Tenable.io/Tenable.sc: scan coverage, credentialed scans, vulnerability age, and scan access to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "snowflake-inspector",
- "source": "./plugins/connectors/snowflake-inspector",
- "description": "GRC connector for Snowflake: MFA, network policies, masking/row access policies, session timeout, and retention to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "wiz-inspector",
- "source": "./plugins/connectors/wiz-inspector",
- "description": "GRC connector for Wiz CNAPP: configuration findings, issues, vulnerabilities, and cloud inventory to v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "testssl-inspector",
- "source": "./plugins/connectors/testssl-inspector",
- "description": "GRC connector wrapping testssl.sh: TLS/SSL protocol, cipher, certificate, and known-CVE checks on HTTPS endpoints → v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "okta-inspector",
- "source": "./plugins/connectors/okta-inspector",
- "description": "GRC connector for Okta: password/MFA/session policies, inactive users, admin factor enrollment \u2192 v1 finding contract",
- "version": "0.1.0"
- },
- {
- "name": "oscal",
- "source": "./plugins/oscal",
- "description": "OSCAL toolkit: validate and convert catalogs, profiles, SSPs, SAPs, SARs, POA&Ms, assessment results, component definitions. Wraps ethanolivertroy/oscal-cli.",
- "version": "0.1.0"
- },
- {
- "name": "fedramp-ssp",
- "source": "./plugins/fedramp-ssp",
- "description": "Convert FedRAMP Rev 5 SSP DOCX templates to validated OSCAL 1.2.0 SSP JSON. Wraps ethanolivertroy/frdocx-to-froscal-ssp.",
- "version": "0.1.0"
- },
- {
- "name": "singapore-pdpa",
- "source": "./plugins/frameworks/singapore-pdpa",
- "description": "Singapore - Personal Data Protection Ac (PDPA) (2012) \u2014 reference-depth plugin backed by the SCF crosswalk (30 SCF \u2192 14 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "us-finra",
- "source": "./plugins/frameworks/us-finra",
- "description": "FINRA Broker-Dealer Cybersecurity Guidance \u2014 stub-depth plugin backed by the SCF crosswalk (17 SCF \u2192 39 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "cyber-essentials-plus",
- "source": "./plugins/frameworks/cyber-essentials-plus",
- "description": "UK NCSC Cyber Essentials Plus (CE+) v3.3 Danzell \u2014 gap assessments, evidence checklists, remediation plans, and cross-framework mapping to ISO 27001 and NIST CSF.",
- "version": "0.1.0"
- },
- {
- "name": "ch-fadp",
- "source": "./plugins/frameworks/ch-fadp",
- "description": "Swiss Federal Act on Data Protection (nFADP) \u2014 stub-depth plugin backed by the SCF crosswalk (35 SCF \u2192 90 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "ind-dpdpa",
- "source": "./plugins/frameworks/ind-dpdpa",
- "description": "India Digital Personal Data Protection Act, 2023 \u2014 reference-depth plugin with scope determination, evidence checklist, and breach-process workflow backed by the SCF crosswalk.",
- "version": "0.1.0"
- },
- {
- "name": "poam-automation",
- "source": "./plugins/connectors/poam-automation",
- "description": "GRC connector wrapping networkbm/POAM-Automation-Tool: converts vulnerability scans into FedRAMP POA&M Excel and emits NIST-800-53-r5 (SI-2) findings \u2192 v1 finding contract.",
- "version": "0.1.0"
- },
- {
- "name": "eu-nis2",
- "source": "./plugins/frameworks/eu-nis2",
- "description": "EU NIS2 Directive (2022) \u2014 reference-depth plugin backed by the SCF crosswalk (68 SCF \u2192 30 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "nist-csf-20",
- "source": "./plugins/frameworks/nist-csf-20",
- "description": "NIST Cybersecurity Framework (v2.0) \u2014 reference-depth plugin backed by the SCF crosswalk (250 SCF \u2192 134 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "us-sox",
- "source": "./plugins/frameworks/us-sox",
- "description": "US Sarbanes-Oxley Act of 2002 (SOX) \u2014 Reference-depth plugin for ICFR scoping, IT General Control (ITGC) testing, and \u00a7302/\u00a7404/\u00a7906 evidence preparation. Backed by the SCF crosswalk (4 SCF \u2192 17 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "us-ccpa",
- "source": "./plugins/frameworks/us-ccpa",
- "description": "California Consumer Privacy Act (CCPA) and California Privacy Rights Act (CPRA) \u2014 Reference plugin with scope determination, evidence checklist, and SCF-backed gap assessment for the California Privacy Protection Agency (CPPA) regulations.",
- "version": "0.1.0"
- },
- {
- "name": "compliance-posture-dashboard",
- "source": "./plugins/dashboards/compliance-posture",
- "description": "Localhost compliance posture dashboard for monitor-continuous JSON output. Reference implementation of the Dashboards category from RFC #38.",
- "version": "0.1.0"
- },
- {
- "name": "jp-appi",
- "source": "./plugins/frameworks/jp-appi",
- "description": "Japan APPI reference plugin with scope, evidence checklist, and SCF-backed gap assessment.",
- "version": "0.1.0"
- },
- {
- "name": "sg-mas-trm",
- "source": "./plugins/frameworks/sg-mas-trm",
- "description": "Singapore MAS TRM reference plugin with scope, evidence checklist, and SCF-backed gap assessment.",
- "version": "0.1.0"
- },
- {
- "name": "au-apra-cps-234",
- "source": "./plugins/frameworks/au-apra-cps-234",
- "description": "APRA CPS 234 reference plugin with scope, evidence checklist, and SCF-backed gap assessment.",
- "version": "0.1.0"
- },
- {
- "name": "us-nerc-cip",
- "source": "./plugins/frameworks/us-nerc-cip",
- "description": "NERC CIP reference plugin with scope, evidence checklist, and SCF-backed gap assessment.",
- "version": "0.1.0"
- },
- {
- "name": "grc-portfolio",
- "source": "./plugins/grc-portfolio",
- "description": "Build and deploy a professional portfolio website for GRC engineers — certifications, frameworks, audit experience, and AWS hosting.",
- "version": "0.1.0"
- },
- {
- "name": "trust-center",
- "source": "./plugins/trust-center",
- "description": "Build and deploy a serverless trust center — public compliance posture, gated document access with optional NDA e-signature, admin dashboard. Deploys to AWS.",
- "version": "0.1.0"
- },
- {
- "name": "nist-ai-rmf",
- "source": "./plugins/frameworks/nist-ai-rmf",
- "description": "NIST AI 100-1 (AI RMF 1.0) \u2014 stub-depth plugin backed by the SCF crosswalk (158 SCF \u2192 91 framework controls).",
- "version": "0.1.0"
- },
- {
- "name": "nist-ai-600-1",
- "source": "./plugins/frameworks/nist-ai-600-1",
- "description": "NIST AI 600-1 (Generative AI Profile) \u2014 stub-depth plugin backed by the SCF crosswalk (139 SCF controls map to 250 profile items and suggested actions).",
- "version": "0.1.0"
- }
- ]
- }
README.md · README · 161 lines
- # claude-grc-engineering
- 
- [](https://github.com/GRCEngClub/claude-grc-engineering/pulls?q=commenter%3Agreptile-apps%5Bbot%5D)
- [](https://github.com/GRCEngClub/claude-grc-engineering/actions/workflows/osv-scanner.yml)
- [](https://www.greptile.com/?utm_source=oss_badge&utm_medium=readme&utm_campaign=greptile_for_open_source)
- https://github.com/user-attachments/assets/a83aa297-9fba-4a7d-b56c-06f962d1ec6b
- Open-source GRC Engineering resource for Claude.
- `claude-grc-engineering` turns technical evidence from cloud, SaaS, code, and security tools into framework-aligned findings, gap reports, remediation guidance, evidence packages, and OSCAL workflows.
- It is built for the Claude ecosystem: Claude Code plugin installs first, with Claude Desktop and Claude Cowork usage supported through the same Markdown skills, command runbooks, schemas, and repository files.
- It is maintained by the [GRC Engineering Club](https://grcengclub.com) for people who want compliance work to behave more like engineering work: repeatable, testable, versioned, and easy to extend.
- > Not affiliated with Anthropic. Claude, Anthropic, and related marks are property of their respective owners.
- ## What it does
- The toolkit is a Claude Code plugin marketplace. The same plugin skills and command runbooks are also useful in Claude Desktop and Claude Cowork when you add this repository as project context or a shared workspace. Install the pieces you need:
- - `grc-engineer`: the core automation hub for gap assessment, IaC scanning, evidence collection, remediation generation, policy generation, PR review, continuous monitoring, and multi-framework optimization.
- - Persona plugins: workflows for auditors, internal GRC teams, third-party risk, reporting, learning, and iterative GRC automation.
- - Framework plugins: reference guidance for SOC 2, NIST 800-53, ISO 27001, FedRAMP, PCI DSS, CMMC, HITRUST, CIS Controls, GDPR, DORA, HIPAA Security, regional privacy/security regimes, and more.
- - Connector plugins: thin wrappers around tools such as AWS CLI, GitHub CLI, gcloud, Azure CLI, Okta, Slack, Datadog, CrowdStrike, Drata, Splunk, Tenable, Snowflake, and POA&M automation.
- - Diagram plugins: editable draw.io system boundaries, evidence flows, control maps, risk treatment, audit workflows, framework crosswalks, TPRM, POA&M, data flows, RACI, and operating model visuals.
- - OSCAL and bridge plugins: tooling for FedRAMP/OSCAL workflows and integrations with external GRC systems.
- The common path is:
- ```text
- connectors collect evidence
- ↓
- findings match schemas/finding.schema.json
- ↓
- grc-engineer maps findings through SCF
- ↓
- reports, remediation, evidence packages, OSCAL outputs
- ```
- The Secure Controls Framework (SCF) crosswalk is used as the control backbone: 1,468 controls mapped to 249 frameworks. The toolkit references control IDs and implementation guidance; it does not reproduce copyrighted standards text.
- ## Install in 60 seconds
- Inside Claude Code:
- ```bash
- /plugin marketplace add GRCEngClub/claude-grc-engineering
- /plugin install grc-engineer@grc-engineering-suite
- ```
- For a first run without cloud credentials, use GitHub as the evidence source:
- ```bash
- /plugin install github-inspector@grc-engineering-suite
- /plugin install soc2@grc-engineering-suite
- /github-inspector:setup
- /github-inspector:collect --scope=@me
- /grc-engineer:gap-assessment SOC2 --sources=github-inspector
- ```
- Full walkthrough: [docs/QUICKSTART.md](docs/QUICKSTART.md).
- Using Claude Desktop or Claude Cowork instead of Claude Code? Start with [docs/CLAUDE-COWORK.md](docs/CLAUDE-COWORK.md). Anthropic's security and compliance posture is documented at [trust.anthropic.com](https://trust.anthropic.com/), and the Claude Cowork third-party platform guide is here: [Claude Desktop on third-party platforms](https://claude.com/docs/cowork/3p/overview).
- ## Common workflows
- | Goal | Command |
- |---|---|
- | Run a gap assessment against one or more frameworks | `/grc-engineer:gap-assessment` |
- | Scan Terraform, CloudFormation, or Kubernetes for compliance issues | `/grc-engineer:scan-iac` |
- | Run available control checks (results may be indeterminate) | `/grc-engineer:test-control` |
- | Generate remediation code, scripts, or policy | `/grc-engineer:generate-implementation`, `/grc-engineer:generate-policy` |
- | Map one control across frameworks | `/grc-engineer:map-controls-unified` |
- | Find conflicting requirements across frameworks | `/grc-engineer:find-conflicts` |
- | Optimize a multi-framework control plan | `/grc-engineer:optimize-multi-framework` |
- | Collect evidence from cloud/SaaS/code systems | connector-specific setup, collect, and status commands |
- | Build audit workpapers or evidence packages | `/grc-auditor:generate-workpaper`, `/grc-engineer:collect-evidence` |
- | Generate OSCAL SSP/SAP/SAR/POA&M outputs | `/oscal:*`, `/fedramp-ssp:*` |
- | Draft leadership updates and automation coverage reports | `/report:exec-summary`, `/report:automation-coverage` |
- | Create editable GRC diagrams | `/grc-diagrams:drawio`, `/grc-diagrams:system-boundary`, `/grc-diagrams:evidence-flow`, `/grc-diagrams:control-map` |
- | Learn a framework, control, or GRC role | `/teach-me:framework`, `/teach-me:control`, `/teach-me:role`, `/teach-me:quiz` |
- | Run an academic research project end-to-end | `/academic-research-companion:research` |
- Every command has a reference page in its plugin's `commands/` directory.
- ## Plugin map
- Use `/grc-engineer:frameworks` to discover framework coverage and plugin depth.
- High-level categories:
- | Category | Examples |
- |---|---|
- | Engineering hub | `grc-engineer` |
- | Persona/workflow plugins | `grc-auditor`, `grc-internal`, `grc-tprm`, `grc-reporter`, `grc-loop`, `teach-me`, `academic-research-companion` |
- | Diagram plugin | `grc-diagrams` for editable draw.io GRC diagrams |
- | Framework plugins | `soc2`, `nist-800-53`, `iso27001`, `fedramp-rev5`, `fedramp-20x`, `pci-dss`, `cmmc`, `hitrust`, `cis-controls`, `gdpr`, `dora`, `us-hipaa-security`, and others |
- | Connector plugins | `aws-inspector`, `github-inspector`, `gcp-inspector`, `azure-inspector`, `okta-inspector`, `slack-inspector`, `datadog-inspector`, `crowdstrike-inspector`, `drata-inspector`, `splunk-inspector`, `tenable-inspector`, `snowflake-inspector` |
- | Dashboards, knowledge sources | `compliance-posture-dashboard`, `gcp-docs` |
- | OSCAL/FedRAMP tooling | `oscal`, `fedramp-ssp`, POA&M automation plugins |
- The marketplace manifest lives at [.claude-plugin/marketplace.json](.claude-plugin/marketplace.json).
- ## Data contract
- Every connector emits Findings that match [schemas/finding.schema.json](schemas/finding.schema.json). A Finding is one resource with one or more control evaluations.
- That contract keeps connectors small: each connector only needs to collect and normalize evidence. `grc-engineer` handles framework expansion, reporting, remediation, and downstream workflows.
- For the full architecture and schema example, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).
- ## Documentation
- - [docs/QUICKSTART.md](docs/QUICKSTART.md): first gap assessment in about 10 minutes
- - [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md): pipeline model, data contract, plugin categories, extensibility
- - [docs/FRAMEWORK-COVERAGE.md](docs/FRAMEWORK-COVERAGE.md): generated coverage for SCF-mapped frameworks
- - [docs/FRAMEWORK-PLUGIN-GUIDE.md](docs/FRAMEWORK-PLUGIN-GUIDE.md): scaffold and level up framework plugins
- - [docs/GRC-DATA.md](docs/GRC-DATA.md): user-owned `grc-data/` contracts for metrics, risks, vendors, exceptions, and policies
- - [docs/ENTERPRISE-DEPLOYMENT.md](docs/ENTERPRISE-DEPLOYMENT.md): AWS Bedrock, Claude Platform on AWS, and Google Vertex AI guidance
- - [docs/CLAUDE-COWORK.md](docs/CLAUDE-COWORK.md): Claude Desktop and Claude Cowork file-oriented usage, including third-party platform handoff notes
- - [Anthropic Trust Center](https://trust.anthropic.com/): Anthropic security, compliance, and trust resources
- - [Claude Desktop on third-party platforms](https://claude.com/docs/cowork/3p/overview): official Cowork platform guidance
- - [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md): how to contribute connectors, framework guidance, and docs
- - [docs/SCF-ATTRIBUTION.md](docs/SCF-ATTRIBUTION.md): SCF licensing and attribution
- ## Contributing
- Contributions are welcome from GRC practitioners, auditors, security engineers, platform teams, framework experts, and commercial GRC vendors.
- The highest-value contributions are:
- - New connector plugins
- - Improvements to existing connectors
- - Framework plugin guidance and evidence patterns
- - Real-world remediation examples
- - Documentation that helps practitioners learn GRC engineering
- First-time contributors follow the issue → vouch → PR flow described in [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) and [GOVERNANCE.md](GOVERNANCE.md).
- Security-sensitive reports should use the private advisory process described in [SECURITY.md](SECURITY.md).
- ## Status
- Pre-1.0. The Finding schema is versioned, and breaking changes are documented in [CHANGELOG.md](CHANGELOG.md).
- ## Star History
- <a href="https://www.star-history.com/?repos=GRCEngClub%2Fclaude-grc-engineering&type=date&legend=top-left">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=GRCEngClub/claude-grc-engineering&type=date&theme=dark&legend=top-left" />
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=GRCEngClub/claude-grc-engineering&type=date&legend=top-left" />
- <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=GRCEngClub/claude-grc-engineering&type=date&legend=top-left" />
- </picture>
- </a>
- ## License
- MIT for original code, copyright © GRC Engineering Club contributors. Exceptions are documented in [LICENSE](LICENSE). The CIS Controls plugin is CC BY-SA 4.0 per upstream terms. SCF data is CC BY-ND 4.0 and redistributed verbatim.
plugins/grc-engineer/src/evidence-collector.js · Bundled script · 607 lines · 1 finding marked
- /**
- * Evidence Artifact Collector
- * Generates scripts to collect audit evidence from multiple cloud providers
- *
- * Supported providers: AWS, Azure, GCP, Kubernetes
- * Supported formats: python, bash
- */
- import {
- loadProvider,
- listProviders,
- findMatchingTemplate,
- getNISTControl,
- getCloudCommands,
- getAllCloudCommands,
- getControlsByFedRAMPBaseline,
- getExportControlCommands,
- generateEvidenceScript as generateBaselineEvidenceScript
- } from './config-loader.js';
- // Legacy templates for backward compatibility (will be deprecated)
- const LEGACY_TEMPLATES = {
- aws: {
- python: {
- default: `#!/usr/bin/env python3
- """
- Evidence Collection Script
- Control: {control}
- Provider: AWS
- Generated: {timestamp}
- """
- import boto3
- import json
- from datetime import datetime
- def collect_evidence():
- """Collect evidence for: {control}"""
- evidence = {
- "control": "{control}",
- "timestamp": datetime.utcnow().isoformat(),
- "provider": "AWS",
- "results": []
- }
- # Add your evidence collection logic here
- return evidence
- if __name__ == "__main__":
- result = collect_evidence()
- print(json.dumps(result, indent=2))
- `
- },
- bash: {
- default: `#!/bin/bash
- # Evidence Collection Script
- # Control: {control}
- # Provider: AWS
- # Generated: {timestamp}
- echo "Collecting evidence for: {control}"
- # Add your AWS CLI evidence collection commands here
- `
- }
- }
- };
- /**
- * Generate an evidence collection script for a specific control and provider
- * @param {string} control - The control requirement to collect evidence for
- * @param {string} provider - Cloud provider (aws, azure, gcp, kubernetes)
- * @param {string} format - Output format (python, bash)
- * @returns {Promise<Object>} Generated script and metadata
- */
- export async function generateEvidenceScript(control, provider = 'aws', format = 'python') {
- const timestamp = new Date().toISOString();
- const normalizedProvider = provider.toLowerCase();
- const normalizedFormat = format.toLowerCase();
- // Validate format
- if (!['python', 'bash'].includes(normalizedFormat)) {
- throw new Error(`Unsupported format: ${format}. Supported: python, bash`);
- }
- let script;
- let templateKey;
- let instructions;
- try {
- // Try to load from YAML config
- const providerConfig = await loadProvider(normalizedProvider);
- const { key, template } = findMatchingTemplate(control, providerConfig);
- templateKey = key;
- // Get the script for the requested format
- if (template.formats && template.formats[normalizedFormat]) {
- script = template.formats[normalizedFormat];
- instructions = template.instructions || generateDefaultInstructions(normalizedProvider, normalizedFormat);
- } else {
- // Fall back to legacy templates
- script = LEGACY_TEMPLATES[normalizedProvider]?.[normalizedFormat]?.default ||
- LEGACY_TEMPLATES.aws[normalizedFormat]?.default;
- instructions = generateDefaultInstructions(normalizedProvider, normalizedFormat);
- }
- } catch (error) {
- // Fall back to legacy templates if config not found
- console.warn(`Config not found for ${provider}, using legacy template: ${error.message}`);
- script = LEGACY_TEMPLATES[normalizedProvider]?.[normalizedFormat]?.default ||
- LEGACY_TEMPLATES.aws[normalizedFormat]?.default;
- templateKey = 'default';
- instructions = generateDefaultInstructions(normalizedProvider, normalizedFormat);
- }
- if (!script) {
- throw new Error(`No template available for provider: ${provider}, format: ${format}`);
- }
- // Replace placeholders
- const processedScript = script
- .replace(/{timestamp}/g, timestamp)
- .replace(/{control}/g, control)
- .replace(/{provider}/g, provider.toUpperCase());
- return {
- control,
- provider: normalizedProvider,
- format: normalizedFormat,
- script: processedScript,
- metadata: {
- generated: timestamp,
- template_key: templateKey,
- config_source: templateKey !== 'default' ? 'yaml' : 'legacy'
- },
- instructions
- };
- }
- /**
- * Generate default instructions for a provider/format combination
- * @param {string} provider - Cloud provider
- * @param {string} format - Script format
- * @returns {string} Instructions markdown
- */
- function generateDefaultInstructions(provider, format) {
- const instructions = {
- aws: {
- python: `## AWS Python Evidence Collection
- 1. **Install dependencies:**
- \`\`\`bash
- pip install boto3
- \`\`\`
- 2. **Configure AWS credentials:**
- \`\`\`bash
- aws configure
- # Or set environment variables:
- export AWS_ACCESS_KEY_ID=your-key
- export AWS_SECRET_ACCESS_KEY=your-secret
- export AWS_DEFAULT_REGION=us-east-1
- \`\`\`
- 3. **Run the script:**
- \`\`\`bash
- python3 evidence_script.py > evidence_report.json
- \`\`\`
- 4. **Review the output and save for audit documentation**
- `,
- bash: `## AWS CLI Evidence Collection
- 1. **Install AWS CLI:**
- \`\`\`bash
- # macOS
- brew install awscli
- # Linux
- curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
- \`\`\`
- 2. **Configure AWS CLI:**
- \`\`\`bash
- aws configure
- \`\`\`
- 3. **Make script executable and run:**
- \`\`\`bash
- chmod +x evidence_script.sh
- ./evidence_script.sh > evidence_report.txt
- \`\`\`
- `
- },
- azure: {
- python: `## Azure Python Evidence Collection
- 1. **Install dependencies:**
- \`\`\`bash
- pip install azure-identity azure-mgmt-resource azure-mgmt-storage msgraph-sdk
- \`\`\`
- 2. **Configure Azure credentials:**
- \`\`\`bash
- az login
- # Or use service principal with environment variables
- \`\`\`
- 3. **Run the script:**
- \`\`\`bash
- python3 evidence_script.py > evidence_report.json
- \`\`\`
- `,
- bash: `## Azure CLI Evidence Collection
- 1. **Install Azure CLI:**
- \`\`\`bash
- # macOS
- brew install azure-cli
- # Linux
- curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 221 on GitHub
- \`\`\`
- 2. **Login to Azure:**
- \`\`\`bash
- az login
- az account set --subscription <subscription-id>
- \`\`\`
- 3. **Make script executable and run:**
- \`\`\`bash
- chmod +x evidence_script.sh
- ./evidence_script.sh > evidence_report.txt
- \`\`\`
- `
- },
- gcp: {
- python: `## GCP Python Evidence Collection
- 1. **Install dependencies:**
- \`\`\`bash
- pip install google-cloud-storage google-cloud-kms google-cloud-resource-manager
- \`\`\`
- 2. **Configure GCP credentials:**
- \`\`\`bash
- gcloud auth application-default login
- # Or set GOOGLE_APPLICATION_CREDENTIALS
- \`\`\`
- 3. **Run the script:**
- \`\`\`bash
- python3 evidence_script.py > evidence_report.json
- \`\`\`
- `,
- bash: `## GCP CLI Evidence Collection
- 1. **Install Google Cloud SDK:**
- \`\`\`bash
- # macOS
- brew install google-cloud-sdk
- # Linux
- curl https://sdk.cloud.google.com | bash
- \`\`\`
- 2. **Authenticate:**
- \`\`\`bash
- gcloud auth login
- gcloud config set project PROJECT_ID
- \`\`\`
- 3. **Make script executable and run:**
- \`\`\`bash
- chmod +x evidence_script.sh
- ./evidence_script.sh > evidence_report.txt
- \`\`\`
- `
- },
- kubernetes: {
- python: `## Kubernetes Python Evidence Collection
- 1. **Install dependencies:**
- \`\`\`bash
- pip install kubernetes
- \`\`\`
- 2. **Configure cluster access:**
- \`\`\`bash
- # Ensure kubeconfig is set up
- kubectl cluster-info
- \`\`\`
- 3. **Run the script:**
- \`\`\`bash
- python3 evidence_script.py > evidence_report.json
- \`\`\`
- `,
- bash: `## Kubernetes CLI Evidence Collection
- 1. **Install kubectl:**
- \`\`\`bash
- # macOS
- brew install kubectl
- \`\`\`
- 2. **Configure cluster access:**
- \`\`\`bash
- # EKS
- aws eks update-kubeconfig --name CLUSTER_NAME
- # AKS
- az aks get-credentials --name CLUSTER_NAME
- # GKE
- gcloud container clusters get-credentials CLUSTER_NAME
- \`\`\`
- 3. **Make script executable and run:**
- \`\`\`bash
- chmod +x evidence_script.sh
- ./evidence_script.sh > evidence_report.txt
- \`\`\`
- `
- }
- };
- return instructions[provider]?.[format] || 'See script comments for usage instructions.';
- }
- /**
- * List available providers
- * @returns {Promise<string[]>} Array of provider names
- */
- export async function getAvailableProviders() {
- return listProviders();
- }
- // ============================================================================
- // NIST 800-53 Control Evidence Collection
- // ============================================================================
- /**
- * Generate evidence collection commands for a specific NIST 800-53 control
- * @param {string} controlId - NIST control ID (e.g., "AC-2", "AU-6")
- * @param {string} provider - Cloud provider (aws, azure, gcp, kubernetes)
- * @returns {Promise<Object>} Control information with CLI commands and evidence script
- */
- export async function generateNISTControlEvidence(controlId, provider = 'aws') {
- const timestamp = new Date().toISOString();
- const normalizedProvider = provider.toLowerCase();
- const commandInfo = await getCloudCommands(controlId, normalizedProvider);
- // Build a standalone evidence script from the commands
- let script = `#!/bin/bash
- # NIST 800-53 Evidence Collection Script
- # Control: ${commandInfo.controlId}
- # Title: ${commandInfo.controlTitle || 'N/A'}
- # Provider: ${normalizedProvider.toUpperCase()}
- # Generated: ${timestamp}
- set -e
- echo "============================================"
- echo "NIST 800-53 Evidence Collection"
- echo "Control: ${commandInfo.controlId}"
- echo "Provider: ${normalizedProvider.toUpperCase()}"
- echo "Date: $(date -u +%Y-%m-%dT%H:%M:%SZ)"
- echo "============================================"
- echo ""
- `;
- if (commandInfo.evidence_script) {
- script += commandInfo.evidence_script;
- } else if (commandInfo.commands && commandInfo.commands.length > 0) {
- for (const cmd of commandInfo.commands) {
- script += `
- echo ">> ${cmd.description}"
- ${cmd.cmd} || echo "Command failed or not applicable"
- echo ""
- `;
- }
- } else {
- script += `echo "No automated evidence collection commands available for this control on ${normalizedProvider}."\n`;
- }
- script += `
- echo "============================================"
- echo "Evidence Collection Complete"
- echo "============================================"
- `;
- return {
- controlId: commandInfo.controlId,
- controlTitle: commandInfo.controlTitle,
- controlDescription: commandInfo.controlDescription,
- provider: normalizedProvider,
- commands: commandInfo.commands || [],
- script,
- metadata: {
- generated: timestamp,
- framework: 'NIST 800-53',
- hasAutomatedEvidence: !!(commandInfo.evidence_script || (commandInfo.commands && commandInfo.commands.length > 0))
- }
- };
- }
- /**
- * Generate evidence collection for all providers for a NIST control
- * @param {string} controlId - NIST control ID
- * @returns {Promise<Object>} Commands organized by provider
- */
- export async function generateNISTControlEvidenceAllProviders(controlId) {
- const timestamp = new Date().toISOString();
- const allCommands = await getAllCloudCommands(controlId);
- const result = {
- controlId: allCommands.controlId,
- controlTitle: allCommands.controlTitle,
- controlDescription: allCommands.controlDescription,
- metadata: {
- generated: timestamp,
- framework: 'NIST 800-53'
- },
- providers: {}
- };
- for (const [provider, providerData] of Object.entries(allCommands.providers)) {
- result.providers[provider] = {
- commands: providerData.commands || [],
- evidence_script: providerData.evidence_script || null
- };
- }
- return result;
- }
- // ============================================================================
- // FedRAMP Baseline Evidence Collection
- // ============================================================================
- /**
- * Generate a complete evidence collection script for a FedRAMP baseline
- * @param {string} baseline - FedRAMP baseline (low, moderate, high)
- * @param {string} provider - Cloud provider
- * @returns {Promise<Object>} Full evidence collection script and metadata
- */
- export async function generateFedRAMPBaselineEvidence(baseline, provider = 'aws') {
- const timestamp = new Date().toISOString();
- const normalizedBaseline = baseline.toLowerCase();
- const normalizedProvider = provider.toLowerCase();
- // Get all controls for this baseline
- const controls = await getControlsByFedRAMPBaseline(normalizedBaseline);
- // Generate the combined script
- const script = await generateBaselineEvidenceScript(normalizedBaseline, normalizedProvider);
- // Count controls with automated evidence
- let automatedCount = 0;
- let manualCount = 0;
- for (const control of controls) {
- if (control.cloud_tests && control.cloud_tests[normalizedProvider]) {
- automatedCount++;
- } else {
- manualCount++;
- }
- }
- return {
- baseline: normalizedBaseline,
- provider: normalizedProvider,
- script,
- metadata: {
- generated: timestamp,
- totalControls: controls.length,
- automatedControls: automatedCount,
- manualControls: manualCount,
- coveragePercent: controls.length > 0 ? Math.round((automatedCount / controls.length) * 100) : 0
- },
- controlSummary: controls.map(c => ({
- id: c.id,
- title: c.title,
- family: c.family,
- hasAutomatedEvidence: !!(c.cloud_tests && c.cloud_tests[normalizedProvider])
- }))
- };
- }
- /**
- * Get a summary of FedRAMP baseline controls with evidence availability
- * @param {string} baseline - FedRAMP baseline
- * @param {string} provider - Cloud provider
- * @returns {Promise<Object>} Summary of controls and evidence availability
- */
- export async function getFedRAMPBaselineSummary(baseline, provider = 'aws') {
- const normalizedBaseline = baseline.toLowerCase();
- const normalizedProvider = provider.toLowerCase();
- const controls = await getControlsByFedRAMPBaseline(normalizedBaseline);
- // Group by family
- const byFamily = {};
- for (const control of controls) {
- const family = control.family || 'Unknown';
- if (!byFamily[family]) {
- byFamily[family] = {
- familyName: control.familyName,
- total: 0,
- automated: 0,
- controls: []
- };
- }
- byFamily[family].total++;
- const hasAutomated = !!(control.cloud_tests && control.cloud_tests[normalizedProvider]);
- if (hasAutomated) {
- byFamily[family].automated++;
- }
- byFamily[family].controls.push({
- id: control.id,
- title: control.title,
- hasAutomatedEvidence: hasAutomated
- });
- }
- return {
- baseline: normalizedBaseline,
- provider: normalizedProvider,
- totalControls: controls.length,
- families: byFamily
- };
- }
- // ============================================================================
- // Export Control Framework Evidence Collection
- // ============================================================================
- /**
- * Generate evidence collection for export control framework
- * @param {string} framework - Framework name (itar, irap, ismap)
- * @param {string} provider - Cloud provider
- * @returns {Promise<Object>} Evidence collection script and commands
- */
- export async function generateExportControlEvidence(framework, provider = 'aws') {
- const timestamp = new Date().toISOString();
- const normalizedProvider = provider.toLowerCase();
- const frameworkData = await getExportControlCommands(framework, normalizedProvider);
- // Build evidence script
- let script = `#!/bin/bash
- # Export Control Evidence Collection Script
- # Framework: ${frameworkData.framework}
- # Version: ${frameworkData.version}
- # Provider: ${normalizedProvider.toUpperCase()}
- # Generated: ${timestamp}
- set -e
- echo "============================================"
- echo "Export Control Evidence Collection"
- echo "Framework: ${frameworkData.framework}"
- echo "Provider: ${normalizedProvider.toUpperCase()}"
- echo "Date: $(date -u +%Y-%m-%dT%H:%M:%SZ)"
- echo "============================================"
- echo ""
- `;
- for (const control of frameworkData.controls) {
- script += `
- # ============================================
- # ${control.id}: ${control.title}
- # ============================================
- echo "=== ${control.id}: ${control.title} ==="
- `;
- if (control.evidence_script) {
- script += control.evidence_script;
- } else if (control.commands && control.commands.length > 0) {
- for (const cmd of control.commands) {
- script += `echo ">> ${cmd.description}"\n`;
- script += `${cmd.cmd} || echo "Command failed or not applicable"\n`;
- script += `echo ""\n`;
- }
- }
- }
- script += `
- echo "============================================"
- echo "Evidence Collection Complete"
- echo "============================================"
- `;
- return {
- framework: frameworkData.framework,
- version: frameworkData.version,
- provider: normalizedProvider,
- script,
- controls: frameworkData.controls,
- metadata: {
- generated: timestamp,
- totalControls: frameworkData.controls.length
- }
- };
- }
plugins/grc-portfolio/scripts/bootstrap.sh · Bundled script · 183 lines · 1 finding marked
- #!/bin/bash
- # AWS Website Deployment - Bootstrap Script
- # This script sets up your local environment for deploying websites to AWS
- set -e # Exit on any error
- # Colors for output
- RED='\033[0;31m'
- GREEN='\033[0;32m'
- YELLOW='\033[1;33m'
- BLUE='\033[0;34m'
- NC='\033[0m' # No Color
- # Print functions
- print_header() {
- echo -e "\n${BLUE}========================================${NC}"
- echo -e "${BLUE}$1${NC}"
- echo -e "${BLUE}========================================${NC}\n"
- }
- print_success() {
- echo -e "${GREEN}✓ $1${NC}"
- }
- print_error() {
- echo -e "${RED}✗ $1${NC}"
- }
- print_warning() {
- echo -e "${YELLOW}⚠ $1${NC}"
- }
- print_info() {
- echo -e "${BLUE}ℹ $1${NC}"
- }
- # Check if command exists
- command_exists() {
- command -v "$1" >/dev/null 2>&1
- }
- print_header "AWS Website Deployment - Environment Setup"
- echo "This script will check and install the necessary tools for deploying your website to AWS."
- echo ""
- # Check Operating System
- print_info "Detecting operating system..."
- OS="$(uname -s)"
- case "${OS}" in
- Linux*) MACHINE=Linux;;
- Darwin*) MACHINE=Mac;;
- MINGW*) MACHINE=Windows;;
- *) MACHINE="UNKNOWN:${OS}"
- esac
- print_success "Operating System: ${MACHINE}"
- # Check for Homebrew (Mac only)
- if [ "$MACHINE" = "Mac" ]; then
- print_info "Checking for Homebrew..."
- if ! command_exists brew; then
- print_warning "Homebrew not found. Installing Homebrew..."
- /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- print_success "Homebrew installed successfully"
- else
- print_success "Homebrew is already installed"
- fi
- fi
- # Check for AWS CLI
- print_info "Checking for AWS CLI..."
- if ! command_exists aws; then
- print_warning "AWS CLI not found. Installing..."
- if [ "$MACHINE" = "Mac" ]; then
- brew install awscli
- elif [ "$MACHINE" = "Linux" ]; then
- curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
- unzip awscliv2.zip
- sudo ./aws/install
- rm -rf aws awscliv2.zip
- else
- print_error "Please install AWS CLI manually from: https://aws.amazon.com/cli/"
- exit 1
- fi
- print_success "AWS CLI installed successfully"
- else
- print_success "AWS CLI is already installed ($(aws --version))"
- fi
- # Check for Node.js
- print_info "Checking for Node.js..."
- if ! command_exists node; then
- print_warning "Node.js not found. Installing..."
- if [ "$MACHINE" = "Mac" ]; then
- brew install node
- elif [ "$MACHINE" = "Linux" ]; then
- curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 101 on GitHub
- sudo apt-get install -y nodejs
- else
- print_error "Please install Node.js manually from: https://nodejs.org/"
- exit 1
- fi
- print_success "Node.js installed successfully"
- else
- print_success "Node.js is already installed ($(node --version))"
- fi
- # Check for npm
- print_info "Checking for npm..."
- if ! command_exists npm; then
- print_error "npm not found. Please reinstall Node.js"
- exit 1
- else
- print_success "npm is already installed ($(npm --version))"
- fi
- # Configure AWS CLI
- print_header "AWS Configuration"
- if [ ! -f ~/.aws/credentials ]; then
- print_warning "AWS credentials not configured"
- echo ""
- echo "You'll need:"
- echo " 1. AWS Access Key ID"
- echo " 2. AWS Secret Access Key"
- echo " 3. Default region (e.g., us-east-1)"
- echo ""
- print_info "You can get these from the AWS Console: IAM → Users → Security Credentials"
- echo ""
- read -p "Would you like to configure AWS now? (y/n) " -n 1 -r
- echo
- if [[ $REPLY =~ ^[Yy]$ ]]; then
- aws configure
- print_success "AWS configured successfully"
- else
- print_warning "Skipping AWS configuration. Run 'aws configure' later to set up credentials"
- fi
- else
- print_success "AWS credentials already configured"
- print_info "Current AWS identity:"
- aws sts get-caller-identity 2>/dev/null || print_warning "Could not verify AWS credentials. You may need to run 'aws configure'"
- fi
- # Verify deployment scripts exist
- print_header "Verifying Deployment Scripts"
- SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
- DEPLOY_SCRIPT="$SCRIPT_DIR/deploy.sh"
- VALIDATE_SCRIPT="$SCRIPT_DIR/validate-stack.sh"
- if [ -f "$DEPLOY_SCRIPT" ]; then
- print_success "deploy.sh found at scripts/deploy.sh"
- else
- print_error "deploy.sh not found! This should not happen."
- fi
- if [ -f "$VALIDATE_SCRIPT" ]; then
- print_success "validate-stack.sh found at scripts/validate-stack.sh"
- else
- print_error "validate-stack.sh not found! This should not happen."
- fi
- print_info "Run these from your project directory (point at the plugin's scripts/):"
- echo " <plugin-root>/scripts/deploy.sh <bucket> <distribution-id> [profile]"
- echo " <plugin-root>/scripts/validate-stack.sh [template-file] [profile]"
- # Summary
- print_header "Setup Complete!"
- echo "✓ All required tools are installed"
- echo ""
- echo "Next steps:"
- echo " 1. From Claude Code, run /grc-portfolio:plan to scaffold your site config."
- echo " 2. Run /grc-portfolio:preflight to validate AWS readiness."
- echo " 3. Run /grc-portfolio:infra to deploy the CloudFormation stack."
- echo " 4. Run /grc-portfolio:deploy to build and publish the site."
- echo ""
- print_success "You're ready to deploy your website to AWS!"
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.