Skip to content

Commit 3d77fa2

Browse files
Automated documentation update [skip ci] (#257)
1 parent e0d1df5 commit 3d77fa2

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

src/run-script/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
# run-script (run-script)
3+
4+
Run a script from a URL or inline text during devcontainer build
5+
6+
## Example Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/devcontainer-community/devcontainer-features/run-script:1": {}
11+
}
12+
```
13+
14+
## Options
15+
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| url | URL of a script to download and execute. | string | - |
19+
| script | Inline script text to execute. | string | - |
20+
21+
# run-script
22+
23+
## Project
24+
25+
_No upstream project — this is a utility feature._
26+
27+
## Description
28+
29+
A utility feature that runs a custom script during devcontainer build. Accepts either a URL pointing to a script to download and execute, or an inline script supplied directly as text. Exactly one of `url` or `script` must be provided.
30+
31+
## Installation Method
32+
33+
No binary is installed. The feature downloads (via `wget` or `curl`) or writes the provided script to a temporary file, then executes it with `bash`. If neither `wget` nor `curl` is available, `curl` is installed automatically via `apt`.
34+
35+
## Other Notes
36+
37+
- If both `url` and `script` are provided the feature fails with an error.
38+
- If neither option is provided the feature exits successfully without doing anything.
39+
- The temporary script file is removed after execution.
40+
41+
42+
---
43+
44+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainer-community/devcontainer-features/blob/main/src/run-script/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)