CLICommands
initLast updated on
Last updated on
Initialize a new Paradoc project
Initializes a new Paradoc project in the current or specified directory.
Usage
paradoc init [directory] [options]Arguments
| Argument | Description |
|---|---|
directory | Directory to initialize (defaults to current directory) |
Options
| Option | Description |
|---|---|
-y, --yes | Non-interactive mode (skip prompts) |
--name <name> | Project title (required in non-interactive mode) |
--description <desc> | Project description |
--visibility <public|private> | Project visibility (default: private) |
--nested | Allow creating nested project inside existing project |
--dry-run | Preview without creating files |
Description
The init command creates a new Paradoc project with the following structure:
my-project/
├── paradoc.json # Project manifest
└── .paradoc/ # CLI state directory (empty until an artifact is installed)The manifest holds $schema, name, title, description, and visibility. The name is @your-org/<title-slug>; replace your-org with your own namespace. Add registries and other settings by hand (see Projects).
In interactive mode, you'll be prompted for:
- Project title
- Description (optional)
- Visibility (public or private)
- Directory name
Examples
Interactive initialization:
paradoc initNon-interactive with all options:
paradoc init --yes --name "My Project" --visibility privateInitialize in a specific directory:
paradoc init my-new-projectPreview what would be created:
paradoc init --dry-run --yes --name "Test Project"