create-metorial 0.0.0-dev.9 → 0.1.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 +51 -0
- package/dist/bin.cjs +2 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# `create-metorial`
|
|
2
|
+
|
|
3
|
+
The official `npm create` entrypoint for Metorial examples.
|
|
4
|
+
|
|
5
|
+
Use `create-metorial` when you want a fast starting point for a Metorial project instead of setting everything up from scratch.
|
|
6
|
+
|
|
7
|
+
## What It Is For
|
|
8
|
+
|
|
9
|
+
Metorial examples are a simple way to see how providers, deployments, sessions, and SDK usage come together in a working project.
|
|
10
|
+
|
|
11
|
+
This package helps you:
|
|
12
|
+
|
|
13
|
+
- browse the official example list
|
|
14
|
+
- pick an example by identifier
|
|
15
|
+
- create a local project from that example
|
|
16
|
+
|
|
17
|
+
## Create A Project
|
|
18
|
+
|
|
19
|
+
List available examples:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm create metorial@latest
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Create a project from an example:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm create metorial@latest <identifier>
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Create it in a specific folder:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm create metorial@latest <identifier> my-app
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Or run the package directly:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx create-metorial@latest
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## When To Use It
|
|
44
|
+
|
|
45
|
+
Use `create-metorial` when:
|
|
46
|
+
|
|
47
|
+
- you want to explore the official examples first
|
|
48
|
+
- you want to start from a working sample app
|
|
49
|
+
- you do not need the full CLI installed yet
|
|
50
|
+
|
|
51
|
+
If you want the full command line experience for login, resource inspection, integrations, and API access, install `@metorial/cli` instead.
|
package/dist/bin.cjs
CHANGED
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
var import_cli_core = require("@metorial/cli-core");
|
|
6
6
|
var args = process.argv.slice(2);
|
|
7
7
|
var cliArgs = args.length === 0 ? ["example", "list"] : ["example", "create", ...args];
|
|
8
|
-
var transform = (0, import_cli_core.replaceOutput)("metorial example create", "npm create");
|
|
8
|
+
var transform = (0, import_cli_core.replaceOutput)("metorial-admin example create", "npm create");
|
|
9
9
|
void (0, import_cli_core.runCLIAndExit)(cliArgs, {
|
|
10
10
|
env: (0, import_cli_core.npmInstallEnvironment)("create-metorial"),
|
|
11
|
+
binary: "metorial-admin",
|
|
11
12
|
stdoutTransform: transform,
|
|
12
13
|
stderrTransform: transform
|
|
13
14
|
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-metorial",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "npm create entrypoint for Metorial examples",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
@@ -16,6 +16,6 @@
|
|
|
16
16
|
"build": "tsup --config tsup.config.ts"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@metorial/cli-core": "0.
|
|
19
|
+
"@metorial/cli-core": "0.1.3"
|
|
20
20
|
}
|
|
21
21
|
}
|