mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 14:24:13 +08:00
docs: add documentation for path_to_claude_code_executable and path_to_bun_executable inputs (#562)
Add documentation for the two previously undocumented inputs that allow users to provide custom executables for specialized environments: - path_to_claude_code_executable: for custom Claude Code binaries - path_to_bun_executable: for custom Bun runtime These inputs are particularly useful for environments like Nix, NixOS, custom containers, and other package management systems where the default installation may not work. Updated files: - docs/usage.md: Added to inputs table - docs/faq.md: Added FAQ entry with examples and use cases - docs/configuration.md: Added dedicated section with examples 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
38
docs/faq.md
38
docs/faq.md
@@ -213,6 +213,44 @@ Check the GitHub Action log for Claude's run for the full execution trace.
|
||||
|
||||
The trigger uses word boundaries, so `@claude` must be a complete word. Variations like `@claude-bot`, `@claude!`, or `claude@mention` won't work unless you customize the `trigger_phrase`.
|
||||
|
||||
### How can I use custom executables in specialized environments?
|
||||
|
||||
For specialized environments like Nix, NixOS, or custom container setups where you need to provide your own executables:
|
||||
|
||||
**Using a custom Claude Code executable:**
|
||||
|
||||
```yaml
|
||||
- uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
path_to_claude_code_executable: "/path/to/custom/claude"
|
||||
# ... other inputs
|
||||
```
|
||||
|
||||
**Using a custom Bun executable:**
|
||||
|
||||
```yaml
|
||||
- uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
path_to_bun_executable: "/path/to/custom/bun"
|
||||
# ... other inputs
|
||||
```
|
||||
|
||||
**Common use cases:**
|
||||
|
||||
- Nix/NixOS environments where packages are managed differently
|
||||
- Docker containers with pre-installed executables
|
||||
- Custom build environments with specific version requirements
|
||||
- Debugging specific issues with particular versions
|
||||
|
||||
**Important notes:**
|
||||
|
||||
- Using an older Claude Code version may cause problems if the action uses newer features
|
||||
- Using an incompatible Bun version may cause runtime errors
|
||||
- The action will skip automatic installation when custom paths are provided
|
||||
- Ensure the custom executables are available in your GitHub Actions environment
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Always specify permissions explicitly** in your workflow file
|
||||
|
||||
Reference in New Issue
Block a user