openmachine/docs/getting-started/installation.md at main · OpenMachineLabs/openmachine · GitHub
Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 3.04 KB

installation.md

File metadata and controls

68 lines (53 loc) · 3.04 KB

Advanced: Install OpenMachine Core from source

For ordinary consumer installations, use the npm installer. This source-build path is for development and platforms without a published npm runtime package. This guide builds the released Python Core from an exact Git tag on macOS or Linux. It does not start a service, configure a tunnel, grant write permission or connect ChatGPT. Complete the Python, SQLite and Git checks first. The following commands run in a terminal on your controller.

Build the released wheel

Choose a parent directory that does not already contain an openmachine clone:

git clone --branch v0.2.23 --depth 1 https://github.com/OpenMachineLabs/openmachine.git
cd openmachine
git rev-parse HEAD
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements.lock
.venv/bin/python -m pip wheel --no-deps --no-build-isolation . --wheel-dir dist
.venv/bin/python -m pip install --no-deps dist/openmachine-0.2.23-py3-none-any.whl
.venv/bin/openmachine --version

For this release, git rev-parse HEAD must match git rev-parse refs/tags/v0.2.23^{commit}. The CLI must report version 0.2.23. A locally built wheel may report an unknown installed commit; the source checkout SHA is build provenance, not proof of an installed runtime's recorded commit.

Use this tag's requirements.lock for both the build and runtime dependencies. Do not mix a wheel from one version with another version's lock. The wheel includes built-in Skills and direct adapters, not tests or your private state.

Make the CLI available in this terminal

From the clone root:

export PATH="$PWD/.venv/bin:$PATH"
openmachine --help

This changes only the current shell. In another terminal, use the absolute path to .venv/bin/openmachine or set that terminal's PATH deliberately. Do not move or delete an environment while a service or original worker still uses it.

Verify the installation boundary

--help and --version establish that the selected CLI can run. They do not validate your configuration, SQLite task store, workspace access or connection. Next, create a disposable workspace in Initial configuration.

Common failures

Symptom Check
Clone requests authentication or returns not found Repository access and the exact official URL; do not put tokens in a command.
Python version rejected or task_sqlite_unsupported The interpreter and its linked SQLite engine, including the interpreter used by the service.
Dependency download fails Network, package-index policy and this exact release's lock. Do not silently unpin dependencies.
openmachine is not found Use .venv/bin/openmachine from the clone or its absolute path.
Another version appears Check which executable your shell selected; source checkout version is not installed version.

Release notes and artifacts are listed on the release page. This source-build route is independent of the npm installer.