forked from farhoodlabs/skills
docs: use explicit bash invocation in all SKILL.md examples
Agents report "not executable" errors when the skill files are delivered without the executable bit preserved. Using `bash ./...` instead of `./...` in all examples avoids this regardless of file permissions in the consuming environment. Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
@@ -28,15 +28,17 @@ Requires `openssl`, `curl`, and `jq` (standard on modern environments).
|
|||||||
The simplest approach is to use `--raw` mode, which prints only the token value. This works reliably in a single shell invocation:
|
The simplest approach is to use `--raw` mode, which prints only the token value. This works reliably in a single shell invocation:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
GH_TOKEN=$(./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN
|
GH_TOKEN=$(bash ./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN
|
||||||
```
|
```
|
||||||
|
|
||||||
You can then use `GH_TOKEN` in subsequent commands within the same shell invocation:
|
You can then use `GH_TOKEN` in subsequent commands within the same shell invocation:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
GH_TOKEN=$(./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN && gh api user
|
GH_TOKEN=$(bash ./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN && gh api user
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **Note:** Using `bash` explicitly ensures the script runs even if the executable bit is not preserved in your environment.
|
||||||
|
|
||||||
### 2. Authenticate the gh CLI
|
### 2. Authenticate the gh CLI
|
||||||
|
|
||||||
With `GH_TOKEN` set (in the same shell), the `gh` CLI operates securely and without needing a separate authentication login for most API operations. Note that `gh auth status` may not reflect the token since it checks local config, but `gh` will respect the `GH_TOKEN` environment variable.
|
With `GH_TOKEN` set (in the same shell), the `gh` CLI operates securely and without needing a separate authentication login for most API operations. Note that `gh auth status` may not reflect the token since it checks local config, but `gh` will respect the `GH_TOKEN` environment variable.
|
||||||
@@ -44,7 +46,7 @@ With `GH_TOKEN` set (in the same shell), the `gh` CLI operates securely and with
|
|||||||
To both generate the token and authenticate `gh` in one go:
|
To both generate the token and authenticate `gh` in one go:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
GH_TOKEN=$(./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN && echo "${GH_TOKEN}" | gh auth login --with-token && gh auth status
|
GH_TOKEN=$(bash ./github-app-token/scripts/generate_token.sh --raw) && export GH_TOKEN && echo "${GH_TOKEN}" | gh auth login --with-token && gh auth status
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Cleanup
|
### 3. Cleanup
|
||||||
@@ -63,12 +65,12 @@ curl -s -X DELETE \
|
|||||||
Without the `--raw` flag, the script outputs `export GH_TOKEN="..."` meant to be `eval`'d. This is the original behavior, preserved for backward compatibility:
|
Without the `--raw` flag, the script outputs `export GH_TOKEN="..."` meant to be `eval`'d. This is the original behavior, preserved for backward compatibility:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
eval "$(./github-app-token/scripts/generate_token.sh)" && gh api user
|
eval "$(bash ./github-app-token/scripts/generate_token.sh)" && gh api user
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> For CI/CD environments (like GitHub Actions), use `--raw` to extract the token cleanly:
|
> For CI/CD environments (like GitHub Actions), use `--raw` to extract the token cleanly:
|
||||||
> `echo "GH_TOKEN=$(./github-app-token/scripts/generate_token.sh --raw)" >> $GITHUB_ENV`
|
> `echo "GH_TOKEN=$(bash ./github-app-token/scripts/generate_token.sh --raw)" >> $GITHUB_ENV`
|
||||||
|
|
||||||
## Security Notes
|
## Security Notes
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user