Skip to content

Automated documentation update #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Automated documentation update #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 3 additions & 23 deletions src/agent-persistence/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,42 +9,22 @@ Persist configurations for coding agents (Claude Code, Codex, Gemini Code Assist

```json
"features": {
"ghcr.io/fjktkm/devcontainer-features/agent-persistence:1": {}
"ghcr.io/peter-wagstaff/devcontainer-features/agent-persistence:1": {}
}
```

## Options

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| scope | Volume scope: `shared` uses one volume across all containers, `per-project` isolates data per dev container within the volume. | string | shared |
| scope | Volume scope: 'shared' uses one volume across all containers (default), 'per-project' isolates data per dev container within the volume. | string | shared |
| claude | Mount Claude Code config (`~/.claude`) via volume. | boolean | true |
| codex | Mount Codex config (`~/.codex`) via volume. | boolean | true |
| gemini | Mount Gemini Code Assist config (`~/.gemini`) and caches (`~/.cache/google-vscode-extension`, `~/.cache/cloud-code`) via volumes. | boolean | true |
| github-cli | Mount GitHub CLI config (`~/.config/gh`) via volume. | boolean | true |

## Per-project scope

By default, all dev containers share a single persistence volume. With `"scope": "per-project"`, each dev container gets an isolated subdirectory within the volume, so credentials and configuration don't leak between projects.

```json
"features": {
"ghcr.io/fjktkm/devcontainer-features/agent-persistence:1": {
"scope": "per-project"
}
}
```

**Required:** When using `per-project` scope, you must also add `DEVCONTAINER_ID` to your `containerEnv` in `devcontainer.json`. This is needed because `${devcontainerId}` substitution is not supported inside feature metadata's `containerEnv`:

```json
"containerEnv": {
"DEVCONTAINER_ID": "${devcontainerId}"
}
```

Without this, the feature falls back to shared scope.

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/fjktkm/devcontainer-features/blob/main/src/agent-persistence/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/peter-wagstaff/devcontainer-features/blob/main/src/agent-persistence/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/color/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A feature to remind you of your favorite color

```json
"features": {
"ghcr.io/fjktkm/devcontainer-features/color:1": {}
"ghcr.io/peter-wagstaff/devcontainer-features/color:1": {}
}
```

Expand All @@ -21,4 +21,4 @@ A feature to remind you of your favorite color

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/fjktkm/devcontainer-features/blob/main/src/color/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/peter-wagstaff/devcontainer-features/blob/main/src/color/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/hello/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A hello world feature

```json
"features": {
"ghcr.io/fjktkm/devcontainer-features/hello:1": {}
"ghcr.io/peter-wagstaff/devcontainer-features/hello:1": {}
}
```

Expand All @@ -21,4 +21,4 @@ A hello world feature

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/fjktkm/devcontainer-features/blob/main/src/hello/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/peter-wagstaff/devcontainer-features/blob/main/src/hello/devcontainer-feature.json). Add additional notes to a `NOTES.md`._