@datadog/create-apps 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -8
- package/dist/bin.js +152 -101
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -14,19 +14,44 @@ Follow the interactive prompts to:
|
|
|
14
14
|
|
|
15
15
|
1. Enter your app name
|
|
16
16
|
2. Select a template
|
|
17
|
-
3. Configure your app (if needed)
|
|
18
17
|
|
|
19
18
|
Your new Datadog App will be created in a directory named after your app.
|
|
20
19
|
|
|
20
|
+
## Templates
|
|
21
|
+
|
|
22
|
+
- `vite-react` — A basic React application bundled with Vite.
|
|
23
|
+
|
|
21
24
|
## Options
|
|
22
25
|
|
|
26
|
+
You can pass a target directory as the first positional argument, plus any of the flags below:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm init @datadog/apps my-app --template vite-react -y
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### `<directory>`
|
|
33
|
+
|
|
34
|
+
Target directory for the new app. If omitted, you'll be prompted.
|
|
35
|
+
|
|
36
|
+
### `--template <name>`
|
|
37
|
+
|
|
38
|
+
Skip the template prompt and use the named template (e.g. `vite-react`).
|
|
39
|
+
|
|
40
|
+
### `--yes`, `-y`
|
|
41
|
+
|
|
42
|
+
Accept all defaults without prompting.
|
|
43
|
+
|
|
44
|
+
### `--overwrite`
|
|
45
|
+
|
|
46
|
+
Overwrite an existing target directory without prompting.
|
|
47
|
+
|
|
23
48
|
### `--skip-post-scaffold`
|
|
24
49
|
|
|
25
50
|
Skip automatic setup commands (dependency installation, git initialization, etc.).
|
|
26
51
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
52
|
+
### `--validate`
|
|
53
|
+
|
|
54
|
+
Validate the bundled templates and exit. Intended for CI / development of this CLI.
|
|
30
55
|
|
|
31
56
|
## What Gets Created
|
|
32
57
|
|
|
@@ -34,7 +59,7 @@ The CLI will:
|
|
|
34
59
|
|
|
35
60
|
- Create a new directory for your app
|
|
36
61
|
- Generate all necessary files from the selected template
|
|
37
|
-
- Integrate Datadog features like
|
|
62
|
+
- Integrate Datadog features like ErrorTracking, Metrics, and more... thanks to our [build-plugins](https://github.com/DataDog/build-plugins).
|
|
38
63
|
- Optionally run setup commands (install dependencies, initialize git)
|
|
39
64
|
|
|
40
65
|
## Next Steps
|
|
@@ -43,11 +68,12 @@ After your app is created:
|
|
|
43
68
|
|
|
44
69
|
```bash
|
|
45
70
|
cd your-app-name
|
|
46
|
-
npm run dev
|
|
47
|
-
npm run build
|
|
71
|
+
npm run dev # local dev server
|
|
72
|
+
npm run build # dry-run production build (no upload)
|
|
73
|
+
npm run upload # build and upload to Datadog (requires DD_API_KEY / DD_APP_KEY)
|
|
48
74
|
```
|
|
49
75
|
|
|
50
|
-
Refer to your app's
|
|
76
|
+
Refer to your app's generated `AGENTS.md` for specific instructions.
|
|
51
77
|
|
|
52
78
|
## License
|
|
53
79
|
|