diff --git a/src/ai-clis/README.md b/src/ai-clis/README.md new file mode 100644 index 0000000..f5d2ba4 --- /dev/null +++ b/src/ai-clis/README.md @@ -0,0 +1,31 @@ + +# AI CLI Tools (ai-clis) + +Installs AI coding assistant CLIs and agentic development tools: Claude Code, Gemini CLI, OpenAI Codex, GitHub Copilot, OpenCode, CodeRabbit, Beads, and Specify CLI. + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/ai-clis:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| claudeCode | Install Claude Code CLI | boolean | true | +| geminiCli | Install Google Gemini CLI | boolean | true | +| codex | Install OpenAI Codex CLI | boolean | true | +| copilot | Install GitHub Copilot CLI | boolean | true | +| openCode | Install OpenCode AI CLI | boolean | true | +| codeRabbit | Install CodeRabbit CLI | boolean | true | +| beads | Install Beads (coding agent memory system) | boolean | true | +| specifyCli | Install Specify CLI (spec-driven development toolkit) | boolean | true | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/ai-clis/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/github-actions-tools/README.md b/src/github-actions-tools/README.md new file mode 100644 index 0000000..4454fba --- /dev/null +++ b/src/github-actions-tools/README.md @@ -0,0 +1,27 @@ + +# GitHub Actions Tools (github-actions-tools) + +Installs tools for local GitHub Actions development: act (local runner) and actionlint (workflow linter). + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/github-actions-tools:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| act | Install act (run GitHub Actions locally) | boolean | true | +| actionlint | Install actionlint (GitHub Actions workflow linter) | boolean | true | +| actVersion | Version of act to install | string | 0.2.84 | +| actionlintVersion | Version of actionlint to install | string | 1.7.10 | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/github-actions-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/modern-cli-tools/README.md b/src/modern-cli-tools/README.md new file mode 100644 index 0000000..a2a84e5 --- /dev/null +++ b/src/modern-cli-tools/README.md @@ -0,0 +1,40 @@ + +# Modern CLI Tools (modern-cli-tools) + +Installs modern CLI replacements and TUI tools: bat, ripgrep, fd, fzf, eza, zoxide, neovim, tmux, lazygit, ast-grep, jujutsu, and optionally zellij. + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/modern-cli-tools:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| bat | Install bat (cat replacement with syntax highlighting) | boolean | true | +| ripgrep | Install ripgrep (fast grep replacement) | boolean | true | +| fd | Install fd (fast find replacement) | boolean | true | +| fzf | Install fzf (fuzzy finder) | boolean | true | +| eza | Install eza (modern ls replacement) | boolean | true | +| zoxide | Install zoxide (smart cd replacement) | boolean | true | +| neovim | Install neovim | boolean | true | +| tmux | Install tmux (terminal multiplexer) | boolean | true | +| lazygit | Install lazygit (Git TUI) | boolean | true | +| astGrep | Install ast-grep (structural search tool) | boolean | true | +| jujutsu | Install jujutsu (jj, next-gen Git-compatible VCS) | boolean | true | +| zellij | Install zellij (terminal workspace) | boolean | false | +| jujutsuVersion | Version of jujutsu to install | string | 0.38.0 | +| ezaVersion | Version of eza to install | string | latest | +| lazygitVersion | Version of lazygit to install | string | 0.59.0 | +| astGrepVersion | Version of ast-grep to install | string | 0.40.5 | +| zellijVersion | Version of zellij to install | string | 0.43.1 | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/modern-cli-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/node-dev-tools/README.md b/src/node-dev-tools/README.md new file mode 100644 index 0000000..951125c --- /dev/null +++ b/src/node-dev-tools/README.md @@ -0,0 +1,28 @@ + +# Node.js Development Tools (node-dev-tools) + +Installs TypeScript toolchain, bundlers, linters, file watchers, and Bun runtime for Node.js development. + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/node-dev-tools:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| typescript | Install TypeScript, ts-node, tsx, and @types/node | boolean | true | +| bundlers | Install vite and esbuild | boolean | true | +| linters | Install prettier, eslint, and biome | boolean | true | +| watchers | Install nodemon, tsc-watch, and concurrently | boolean | true | +| bun | Install Bun JavaScript runtime | boolean | true | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/node-dev-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/python-tools/README.md b/src/python-tools/README.md new file mode 100644 index 0000000..8cd2991 --- /dev/null +++ b/src/python-tools/README.md @@ -0,0 +1,29 @@ + +# Python Development Tools (python-tools) + +Installs Python development tools: uv, Poetry, ruff, and mypy. + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/python-tools:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| uv | Install uv (fast Python package manager) | boolean | true | +| poetry | Install Poetry package manager | boolean | true | +| ruff | Install ruff (fast Python linter and formatter) | boolean | true | +| mypy | Install mypy (static type checker) | boolean | true | +| poetryVersion | Version of Poetry to install | string | 2.3.2 | +| inProjectVenvs | Configure Poetry to create virtualenvs in project directory | boolean | true | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/python-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/rust-dev-tools/README.md b/src/rust-dev-tools/README.md new file mode 100644 index 0000000..42acc36 --- /dev/null +++ b/src/rust-dev-tools/README.md @@ -0,0 +1,26 @@ + +# Rust Development Tools (rust-dev-tools) + +Installs Rust development tools: bacon (build watcher), cargo-edit, and cargo-audit. + +## Example Usage + +```json +"features": { + "ghcr.io/get2knowio/devcontainer-features/rust-dev-tools:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| bacon | Install bacon (cargo build watcher, replaces cargo-watch) | boolean | true | +| cargoEdit | Install cargo-edit (cargo add/rm/upgrade) | boolean | true | +| cargoAudit | Install cargo-audit (security vulnerability checker) | boolean | true | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/get2knowio/devcontainer-features/blob/main/src/rust-dev-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._