From 418e5e0e49534fd2919d92ba13a10addc1ab0f83 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 00:01:08 +0000 Subject: [PATCH 1/4] Initial plan From 0ac3ec83aa00fa5ae73c46b7bb0e3d944f6f3e9a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 00:05:42 +0000 Subject: [PATCH 2/4] Initial plan: Update documentation for script installation path usage Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- .github/workflows/daily-multi-device-docs-tester.lock.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/daily-multi-device-docs-tester.lock.yml b/.github/workflows/daily-multi-device-docs-tester.lock.yml index 3146dac49c..4d270fb16b 100644 --- a/.github/workflows/daily-multi-device-docs-tester.lock.yml +++ b/.github/workflows/daily-multi-device-docs-tester.lock.yml @@ -170,7 +170,7 @@ jobs: const determineAutomaticLockdown = require('/opt/gh-aw/actions/determine_automatic_lockdown.cjs'); await determineAutomaticLockdown(github, context, core); - name: Download container images - run: bash /opt/gh-aw/actions/download_docker_images.sh ghcr.io/github/gh-aw-mcpg:v0.0.96 ghcr.io/github/github-mcp-server:v0.30.2 mcr.microsoft.com/playwright/mcp node:lts-alpine + run: bash /opt/gh-aw/actions/download_docker_images.sh ghcr.io/github/gh-aw-mcpg:v0.0.94 ghcr.io/github/github-mcp-server:v0.30.2 mcr.microsoft.com/playwright/mcp node:lts-alpine - name: Write Safe Outputs Config run: | mkdir -p /opt/gh-aw/safeoutputs @@ -452,7 +452,7 @@ jobs: # Register API key as secret to mask it from logs echo "::add-mask::${MCP_GATEWAY_API_KEY}" export GH_AW_ENGINE="claude" - export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_LOCKDOWN -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /opt:/opt:ro -v /tmp:/tmp:rw -v '"${GITHUB_WORKSPACE}"':'"${GITHUB_WORKSPACE}"':rw ghcr.io/github/gh-aw-mcpg:v0.0.96' + export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_LOCKDOWN -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /opt:/opt:ro -v /tmp:/tmp:rw -v '"${GITHUB_WORKSPACE}"':'"${GITHUB_WORKSPACE}"':rw ghcr.io/github/gh-aw-mcpg:v0.0.94' cat << MCPCONFIG_EOF | bash /opt/gh-aw/actions/start_mcp_gateway.sh { From a79427136eeab52057e16cff169f16ee0e39c23f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 00:06:39 +0000 Subject: [PATCH 3/4] docs: Add note about using full path for script installation without token Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- create.md | 2 ++ docs/src/content/docs/guides/upgrading.md | 2 ++ docs/src/content/docs/setup/cli.md | 2 ++ docs/src/content/docs/troubleshooting/common-issues.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/create.md b/create.md index 5962be997d..35594c9f92 100644 --- a/create.md +++ b/create.md @@ -24,6 +24,8 @@ curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | **What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/` +**Note**: When installing with the script, the CLI will refuse to run if the GitHub token is not available. In this case, you should run the tool using the full local path: `~/.local/share/gh/extensions/gh-aw/gh-aw` instead of using `gh aw`. + **Verify installation**: ```bash diff --git a/docs/src/content/docs/guides/upgrading.md b/docs/src/content/docs/guides/upgrading.md index 433520d3da..98e2946b91 100644 --- a/docs/src/content/docs/guides/upgrading.md +++ b/docs/src/content/docs/guides/upgrading.md @@ -50,6 +50,8 @@ gh extension upgrade gh-aw > curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash > ``` > +> **Note**: When installing with the script, the CLI will refuse to run if the GitHub token is not available. In this case, you should run the tool using the full local path: `~/.local/share/gh/extensions/gh-aw/gh-aw` instead of using `gh aw`. +> Check your version with `gh aw version` and compare against the [latest release](https://github.com/github/gh-aw/releases). If you encounter issues, try a clean reinstall with `gh extension remove gh-aw` followed by `gh extension install github/gh-aw`. diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.md index 10f3410461..f692f52c19 100644 --- a/docs/src/content/docs/setup/cli.md +++ b/docs/src/content/docs/setup/cli.md @@ -62,6 +62,8 @@ curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | Installs to `~/.local/share/gh/extensions/gh-aw/gh-aw` and works with all `gh aw` commands. Supports Linux, macOS, FreeBSD, and Windows. +**Note**: When installing with the script, the CLI will refuse to run if the GitHub token is not available. In this case, you should run the tool using the full local path: `~/.local/share/gh/extensions/gh-aw/gh-aw` instead of using `gh aw`. + ### GitHub Actions Setup Action Install the CLI in GitHub Actions workflows using the `setup-cli` action: diff --git a/docs/src/content/docs/troubleshooting/common-issues.md b/docs/src/content/docs/troubleshooting/common-issues.md index 1c2bb13371..a2fc6ff601 100644 --- a/docs/src/content/docs/troubleshooting/common-issues.md +++ b/docs/src/content/docs/troubleshooting/common-issues.md @@ -19,6 +19,8 @@ curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | After installation, the binary is installed to `~/.local/share/gh/extensions/gh-aw/gh-aw` and can be used with `gh aw` commands just like the extension installation. +**Note**: When installing with the script, the CLI will refuse to run if the GitHub token is not available. In this case, you should run the tool using the full local path: `~/.local/share/gh/extensions/gh-aw/gh-aw` instead of using `gh aw`. + ### Extension Not Found After Installation If you installed the extension but `gh aw` command is not found: From 1742c7965fb53c9decd0ed310ba3151f7a6ca657 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 00:23:34 +0000 Subject: [PATCH 4/4] docs: Align create.md and install.md with copilot-setup approach for both environments Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- create.md | 24 +++++++++++++++++------- install.md | 22 +++++++++++++++++----- 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/create.md b/create.md index 35594c9f92..d644ea8a5e 100644 --- a/create.md +++ b/create.md @@ -22,21 +22,31 @@ to upgrade to latest. If it is not installed, run the installation script from t curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash ``` -**What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/` - -**Note**: When installing with the script, the CLI will refuse to run if the GitHub token is not available. In this case, you should run the tool using the full local path: `~/.local/share/gh/extensions/gh-aw/gh-aw` instead of using `gh aw`. +**What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/gh-aw` **Verify installation**: +The verification and usage approach depends on your environment: + +**Option 1: Local development environment (with GitHub token)** + +If you have GitHub CLI (`gh`) installed and authenticated: + ```bash gh aw version ``` -You should see version information displayed. If you encounter an error, check that: +You can use `gh aw` commands throughout this guide. + +**Option 2: Restricted environment (without GitHub token)** + +If you're in a restricted environment (like Copilot's coding agent) where the GitHub token is not available, use the full path to the binary: + +```bash +~/.local/share/gh/extensions/gh-aw/gh-aw version +``` -- GitHub CLI (`gh`) is installed and authenticated -- The installation script completed without errors -- `~/.local/share/gh/extensions` is in your PATH +In this case, replace all `gh aw` commands in this guide with `~/.local/share/gh/extensions/gh-aw/gh-aw`. ## Step 2: Create the Workflow or do Other Actions diff --git a/install.md b/install.md index 843b7371c6..df2e84dee9 100644 --- a/install.md +++ b/install.md @@ -18,19 +18,31 @@ Run the installation script from the main branch of the gh-aw repository: curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash ``` -**What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/` +**What this does**: Downloads and installs the gh-aw binary to `~/.local/share/gh/extensions/gh-aw/gh-aw` **Verify installation**: +The verification and usage approach depends on your environment: + +**Option 1: Local development environment (with GitHub token)** + +If you have GitHub CLI (`gh`) installed and authenticated: + ```bash gh aw version ``` -You should see version information displayed. If you encounter an error, check that: +You can use `gh aw` commands throughout this guide. + +**Option 2: Restricted environment (without GitHub token)** + +If you're in a restricted environment (like Copilot's coding agent) where the GitHub token is not available, use the full path to the binary: + +```bash +~/.local/share/gh/extensions/gh-aw/gh-aw version +``` -- GitHub CLI (`gh`) is installed and authenticated -- The installation script completed without errors -- `~/.local/share/gh/extensions` is in your PATH +In this case, replace all `gh aw` commands in this guide with `~/.local/share/gh/extensions/gh-aw/gh-aw`. ## Step 2: Initialize Repository for Agentic Workflows