Skip to content

Installation

Assync is not currently published to PyPI. Install it from a cloned checkout of the repository.

Requirements

  • Python 3.11 or later
  • git

Install from source

git clone https://github.com/kalimer00/assync.git
cd assync
python3 -m venv .venv
source .venv/bin/activate
pip install .

pip install . builds and installs the assync package, declared in pyproject.toml, along with its three runtime dependencies: typer, rich, and pyyaml.

Verify the install

assync --help
assync role list

assync --help should list the top-level command groups (init, status, sync, validate, handoff, mission, project, role, run, finding, synthesis, decision, audit, lock). assync role list should print a table of the 27 built-in executable roles plus the non-executable Human Governance Authority — see Built-in Roles.

Development install

To run the test suite or work on Assync itself, install from the repository root the same way — the standard-library unittest suite has no dependency beyond what pip install . already provides:

python3 -m unittest discover -s tests -p "test_*.py"

Uninstall

pip uninstall assync

This removes the installed package only. It never touches a managed project's own .assync-runtime/ data — see Runtime Storage.