Getting started
Quickstart
Plectis runs locally against a folder. Clone the repository, check the included files and generate a local example report.
You need Git and Python 3.11 or newer. This tour uses the source files directly; no package install or model account is needed.
For instructions on running these commands with Claude Code, Codex or Cursor, see Working with a coding agent.
1. Clone the repository
git clone https://github.com/wcook04/plectis
cd plectis2. Check the checkout
From the repository folder, run the bootstrap checks. They use Python and do not require installing the package:
./bootstrap.shThe checks verify that required files are present, scan for excluded private material and validate pattern records. The result is saved to .microcosm/cold_clone_probe.json. Nothing is uploaded.
3. Generate the example report
The tour creates a local work record and prints a report. Its example work step is simulated; it does not run the tests in your project:
PYTHONPATH=src python3 -m microcosm_core tour --card .Optional: more inspection commands and the installed CLI
PYTHONPATH=src python3 -m microcosm_core status --card .
PYTHONPATH=src python3 -m microcosm_core authority --card
PYTHONPATH=src python3 -m microcosm_core workingness --card
PYTHONPATH=src python3 -m microcosm_core hello .
PYTHONPATH=src python3 -m microcosm_core first-screen --card .
PYTHONPATH=src python3 -m microcosm_core legibility-scorecardOr, after installing the local command:
plectis tour --card .
plectis status --card .
plectis authority --card
plectis workingness --card
plectis hello .
plectis first-screen --card .
plectis legibility-scorecardThe legacy microcosm command remains as a compatibility alias for older notes and receipts.
tour --card creates the example record and prints its report. hello lists the available commands without writing files. status reports saved work; authority and workingness describe the limits on what its results establish.