create-factory 0.1.17-alpha.2 → 0.1.17-alpha.4

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.
Files changed (2) hide show
  1. package/README.md +45 -17
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,30 +1,58 @@
1
- # `create-factory`
1
+ # create-factory
2
2
 
3
- `create-factory` scaffolds a Mastra Factory project.
3
+ Mastra Factory is an open source environment for building software with coding agents. Connect your repository to turn issues into plans, implementations, and reviewed pull requests.
4
4
 
5
- ```shell
6
- npm create factory
5
+ `create-factory` is the recommended way to scaffold your Mastra Factory. By default,
6
+
7
+ ## Installation
8
+
9
+ > [!IMPORTANT]
10
+ > Make sure that you have Node.js 22.13.0 or later installed on your system.
11
+
12
+ Run the latest version directly with your package manager.
13
+
14
+ Using npm:
15
+
16
+ ```bash
17
+ npx create-factory@latest
7
18
  ```
8
19
 
9
- It clones the public [`softwarefactory-template`](https://github.com/mastra-ai/softwarefactory-template), installs dependencies, and initializes Git. Run `npm create factory -- --help` for options.
20
+ Using Yarn:
21
+
22
+ ```bash
23
+ yarn dlx create-factory@latest
24
+ ```
10
25
 
11
- Optional Mastra platform setup writes provisioned credentials and resource identifiers to `.env`, enabling cloud sandboxes even when Factory runs locally.
26
+ Using pnpm:
12
27
 
13
- Pass `--no-platform` to skip platform provisioning. This leaves the template `.env` unchanged.
28
+ ```bash
29
+ pnpm create factory@latest
30
+ ```
14
31
 
15
- ## Development
32
+ ## Usage
16
33
 
17
- This package owns prompts, template cloning, package-manager detection, optional Mastra platform setup, dependency installation, and Git initialization.
34
+ The interactive setup asks where to create the project and helps configure your Mastra Factory project.
18
35
 
19
- ```shell
20
- pnpm --filter create-factory test
21
- pnpm --filter create-factory check
22
- pnpm --filter create-factory lint
23
- pnpm --filter create-factory build
36
+ By default, the setup wizard provisions Mastra platform resources during setup, enabling you to fully run Mastra Factory on platform or locally with cloud-backed capabilities. If you prefer to [self-host](https://factory.mastra.ai/deployment#self-host) Mastra Factory, run the setup with the `--no-platform` flag.
37
+
38
+ ```bash
39
+ npx create-factory@latest -- --no-platform
40
+ ```
41
+
42
+ Pass `--help` to see all options:
43
+
44
+ ```bash
45
+ npx create-factory@latest --help
24
46
  ```
25
47
 
26
- Generated project behavior belongs to the separate template repository.
48
+ ## Documentation
49
+
50
+ - [create-factory CLI reference](https://factory.mastra.ai/reference/create-factory)
51
+
52
+ ## Changelog
53
+
54
+ See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/mastracode/mastra-factory/CHANGELOG.md) for version history and release notes.
27
55
 
28
- ## License
56
+ ## Support
29
57
 
30
- Apache-2.0
58
+ We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-factory",
3
- "version": "0.1.17-alpha.2",
3
+ "version": "0.1.17-alpha.4",
4
4
  "description": "Create a Mastra Factory project: an agent-powered software delivery environment built on Mastra. Run `npm create factory` to scaffold and get started.",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -36,7 +36,7 @@
36
36
  "commander": "^14.0.3",
37
37
  "picocolors": "^1.1.1",
38
38
  "tinyexec": "^1.2.4",
39
- "mastra": "1.28.1-alpha.2"
39
+ "mastra": "1.29.0-alpha.4"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@types/node": "22.20.1",