Skip to content

new.project

Create a workspace in an empty or new folder, end to end, as one verb.

The birth seeds the contract, whose [workspace] extensions is the stock list or the one --extensions names, written as its canonical list: no extension another one requires, in composition order. The stock list names python: the workspace's own tests hold the root's set, and run while it holds python. It writes the project's files, locks and syncs its environment, then hands the rest to the runner that environment holds, run as new.project --resume inside the project. There the project's own extensions are mounted, so its tools, its composed and generated files and its forge half come from them at the versions it locked. A folder that holds a project refuses, naming --resume, which finishes that project's birth: every step of it detects done and walks past it, so it is also the recovery after a birth that stopped part way. Headless runs never hang; a missing required answer is a refusal listing what to pass.

fm new.project <folder> [--name=VALUE] [--forge=VALUE] [--owner=VALUE] [--url=VALUE] [--description=VALUE] [--author=VALUE] [--email=VALUE] [--namespace=VALUE] [--extension=VALUE] [--local] [--extensions=VALUE] [--resume]
Parameter Type Default Description
<folder> required where the project is born, an empty or new folder; this one by default
--name=VALUE "" the workspace's name, also the repository's; the folder's by default
--forge=VALUE "" github, gitea, or gitlab; github by default
--owner=VALUE "" the owner or organisation the repository lives under
--url=VALUE "" the forge server (empty for github.com and gitlab.com)
--description=VALUE "" one sentence for the virtual root
--author=VALUE "" the authors entry's name (default: git config)
--email=VALUE "" the authors entry's email (default: git config)
--namespace=VALUE "" dotted namespace packages live in
--extension=VALUE "" also scaffold this named extension package, with its branded App, and self-host it: the workspace becomes the extension's home
--local flag false everything that stays on the machine, nothing that leaves it
--extensions=VALUE "" the extensions the workspace lists, comma-separated, each by name, written as their canonical list; the stock list by default, which names python for the workspace's own tests
--resume flag false

Example

$ fm new.project <folder> --local