PXL CLI

Small command line tool that helps with the development of PXL projects.

Currently, the CLI provides the following commands:

- pxl generate: Generate code for a PXL project
- pxl create-project (alias: pxl new): Create a new PostXL project

pxl generate

The pxl generate command generates code for a PXL project.

$3

In the project root, ensure that a project-schema.json and a generate.ts file exist. See the template project for an example.

``bash
cd /projects/my-project
pxl generate
`

See pxl generate --help for more information.

pxl create-project / pxl new

The pxl create-project command creates a new PostXL project with a selected schema template. It scaffolds the project structure, installs dependencies, runs the initial code generation, and generates the Prisma client.

$3

Run the command from the PostXL repository root:

`bash
pxl create-project


or


pxl new
`

The CLI will interactively prompt you for:

1. Project name: The display name for your project
2. Project slug: A URL-friendly identifier (auto-suggested from the name)
3. Schema template: Choose from available starter schemas
4. Project location: Either a standalone project (outside the workspace) or a workspace project (in the projects/ folder)

$3

| Option | Description |
| --------------------------- | ------------------------------------------- |
| -n, --name | Project name (skip interactive prompt) |
| -s, --slug | Project slug (skip interactive prompt) |
| --schema | Schema template to use |
| -p, --project-path | Custom path for the generated project |
| --skip-git | Skip initializing a git repository |
| --skip-generate | Skip running the initial project generation |

$3

`bash


Interactive mode

pxl new

Non-interactive with all options

pxl new --name "My App" --slug my-app --schema simple

Create at a specific path

pxl new --name "My App" -p /path/to/my-app
`

See pxl create-project --help` for more information.