Project

Setup

Install Project and get a local project ready.

Choose The Installation Source

SourceInstall or update path
Managed macOS arm64Use the pinned installer generated from Project Space Machines; later run project self-update
Managed Linux x64 or WSLInstall the signed machine-tools bundle from the approved GitHub release; later run project self-update
HomebrewUse Homebrew for both installation and updates
Native WindowsRun the approved per-user installer; self-update verifies and points to the next installer
Source checkoutPull and rebuild from source; the updater never overwrites development binaries

Managed releases install the Project CLI and connector as one matching pair. They preserve machine identity and credentials when upgraded.

Homebrew

brew tap DotNaos/project-space https://github.com/DotNaos/project-space
brew install --HEAD DotNaos/project-space/project

Update to the newest version:

brew update
brew reinstall --HEAD DotNaos/project-space/project

project self-update detects Homebrew and leaves its files untouched.

Managed Linux And WSL

Download the versioned Linux x64 machine-tools archive and its checksum from the approved Project Space release. Verify the checksum, extract the archive, and run its install.sh as your normal user. Do not run the installer as root.

After the first managed installation:

project self-update --check
project self-update

Native Windows

Run the approved project-space-machine-tools-windows-x64-setup.exe installer as your normal user. Native Windows checks the signed release with project self-update --check, then reports the exact verified installer URL instead of replacing the running project.exe.

See the repository guides for the full Linux/WSL installation, Windows installation, and connector lifecycle.

First Project

project create my-project
cd my-project

For an existing directory:

project init

Continue with the generated CLI reference or the focused self-update guide.

On this page