Skip to content

Configuration and Quality

Lucas (SatoshiUNO) edited this page Oct 5, 2026 · 5 revisions

Configuration and quality

SYSTEMX runs the commands your project defines. The shipped configuration is empty so it can fit different languages and delivery environments.

Initialize and configure

bash .SYSTEMX/SYSTEMX.sh init

Edit .SYSTEMX/project.json. This example is for a project that already has the listed npm scripts and deployment script; it does not install or scaffold them:

{
  "schemaVersion": 1,
  "project": {
    "name": "example-project",
    "description": "Describe the project's purpose"
  },
  "checks": [
    { "name": "lint", "command": ["npm", "run", "lint"] },
    { "name": "tests", "command": ["npm", "test", "--", "--run"] }
  ],
  "commands": {
    "dev": ["npm", "run", "dev"],
    "build": ["npm", "run", "build"],
    "deploy": ["bash", "scripts/deploy-project.sh"]
  }
}

A Python, Go, Rust, Swift, documentation, or infrastructure project supplies its own command arrays. Empty arrays leave actions unconfigured. Check names must be unique, and every configured check needs a nonempty command.

How execution works

Commands run as argument arrays from the containing project's root. Shell operators, redirects, glob patterns, and $VARIABLE expressions are not automatically expanded. Use a reviewed project script when a workflow needs shell orchestration.

Commands inherit the current environment. Keep credentials in the appropriate environment or secret manager, not command arguments or project JSON. Arguments are displayed in command plans, including dry runs. Configuration is executable project input and must be reviewed before use.

Preview, then run

bash .SYSTEMX/SYSTEMX.sh doctor
bash .SYSTEMX/SYSTEMX.sh check --dry-run
bash .SYSTEMX/SYSTEMX.sh check

doctor checks whether the configured executables are available. A dry run validates records and prints the plan; it executes no project commands. A real check runs configured commands in order and stops at the first failure.

build adds the build command after checks. deploy adds build and deployment after checks. The project deployment script owns target selection, authentication, release policy, and any required confirmation.

Choose evidence appropriate to the change

Change Useful verification
Documentation/configuration Parsing, links, accurate examples, and rendered output
Business logic Focused regression tests and relevant boundary cases
API/data contract Compatibility, validation, partial failure, and migration checks
User interface The affected journey in the actual target surface, including accessibility
Authorization Positive and negative permission cases and isolation boundaries
Release/infrastructure Intended target, reproducible artifact, smoke checks, and recovery evidence

Record the command, revision, environment, result, and evidence location with the related task. Label skipped checks and their reasons. Choose useful checks instead of adding a broad test list that does not establish the requested behavior.

Template checks versus project checks

bash .SYSTEMX/SYSTEMX.sh validate
python3 -I -B -m unittest discover -s .SYSTEMX/tests -v

These validate the template and its command behavior in isolated fixtures. They do not test the adopted application or its cloud services. Application quality is established by the real checks configured for that project.

For a pristine public distribution, additionally run validate --template. It checks only the distribution inventory and reviewed blank seeds; it is expected to reject initialized projects. See Standard format. For scoped source, deployed, functional, and operational claims, use Evidence and acceptance.

See the local quality standard for the evidence contract and the security standard for credential and execution boundaries.

DOT SYSTEMX · User manual

1. Start here

2. Work and continuity

3. Setup and maintenance

4. Advanced reference

5. Project information

Repository · Use this template · MIT license

Clone this wiki locally