diff --git a/src/copilot-persistence/README.md b/src/copilot-persistence/README.md index b17daed..e734777 100644 --- a/src/copilot-persistence/README.md +++ b/src/copilot-persistence/README.md @@ -1,6 +1,17 @@ -# Copilot CLI Persistence Feature -This devcontainer feature persists GitHub Copilot CLI settings and chat history across container rebuilds. +# Copilot CLI Persistence (copilot-persistence) + +Persists GitHub Copilot CLI settings and chat history across rebuilds + +## Example Usage + +```json +"features": { + "ghcr.io/rosstaco/devcontainer-features/copilot-persistence:1": {} +} +``` + + ## How It Works @@ -10,6 +21,8 @@ Inspired by the [shell-history pattern](https://github.com/stuartleeks/dev-conta 2. **Creates a symlink** from `~/.copilot` → `/copilot-data` 3. **Sets ownership** to the container user during installation (auto-detects from `$_REMOTE_USER`) +> **Note:** If `~/.copilot` already exists as a directory during installation, it is moved into the volume at `/copilot-data/migrated-/` before the symlink is created. + ## What Persists - ✅ Chat history and sessions @@ -17,17 +30,6 @@ Inspired by the [shell-history pattern](https://github.com/stuartleeks/dev-conta - ✅ Command history - ✅ Trusted folders -## Usage - -```json -{ - "features": { - "ghcr.io/devcontainers/features/copilot-cli:1": {}, - "ghcr.io/rosstaco/devcontainer-features/copilot-persistence:1": {} - } -} -``` - ## Troubleshooting View the volume data: @@ -39,3 +41,8 @@ Check the symlink: ```bash ls -la ~/.copilot ``` + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/rosstaco/devcontainer-features/blob/main/src/copilot-persistence/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/prompty-dumpty/README.md b/src/prompty-dumpty/README.md index 55dc1f9..0229e85 100644 --- a/src/prompty-dumpty/README.md +++ b/src/prompty-dumpty/README.md @@ -17,20 +17,7 @@ Installs prompty-dumpty CLI tool for managing prompty files |-----|-----|-----|-----| | version | Version of prompty-dumpty to install. Use 'latest' or a specific version like '0.6.2' | string | latest | -## Usage -After installation, the `dumpty` command will be available: - -```bash -dumpty --help -dumpty --version -``` - -## Notes - -This feature installs prompty-dumpty system-wide using pip3 with the `--break-system-packages` flag, which is appropriate for containerized development environments. Python 3 is assumed to be present in the base image. - -For more information about prompty-dumpty, visit: https://pypi.org/project/prompty-dumpty/ ---