// SPDX-License-Identifier: CC-BY-SA-4.0 // SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell = OikosBot Jonathan D.A. Jewell v0.1.0-dev :icons: font

Ecological and economic code-analysis tooling: Rust source-pattern analysis, SARIF reports, advisory Pareto comparisons, and read-only estate telemetry/DEA. OikosBot is not the oikos economics DSL or the sustainabot fleet slot: link:DISAMBIGUATION.adoc[disambiguation].

[IMPORTANT]

Alpha; general launch and regulator claims are on hold. Per-file energy/carbon/time/memory figures are heuristic estimates, including recognized patterns. No row currently has a reproducible calibration receipt. A score, range or frontier membership is not proof of environmental benefit. See link:docs/LAUNCH-READINESS.adoc[launch gates, issue disposition and evidence]. ====

== Start here

== What exists

The standalone Rust workspace supports Rust/JavaScript/Python analysis, pattern findings, JSON/text/SARIF, .oikos.yml, point-vector Pareto comparisons, and estate collect|analyse|report. These are advisory models. The experimental scoped interval contract is a library prototype, not a production gate.

The composite Action and GHCR image have been published previously. The default image is digest-pinned; source fixes do not change it until a reviewed artifact is built, tested and explicitly adopted. This branch’s hardening changes still require Rust/container CI verification.

The AffineScript webhook App remains a scaffold with source-level orchestration; listener/transport and operational parity are not demonstrated. Haskell is an independent analyzer surface. VeriSimDB is the target datastore, not a working runtime client. link:DEPLOY.adoc[Deployment boundaries].

== Run an advisory report

[source,shell]

cargo build –locked -p oikosbot-cli ./target/debug/oikosbot report crates/oikosbot-analysis/src –format sarif –output results.sarif ./target/debug/oikosbot compare /path/to/base /path/to/head –format json —-

report does not enforce. Explicit checks without sufficient evidence return 2 (no check performed), not a green pass; 1 is reserved for a supported negative check. This intentionally changes earlier behavior: heuristic checks used to warn and exit 0, and text threshold checks could fail while JSON/SARIF did not. See link:docs/usage.adoc[compatibility and exit semantics].

== Estate analysis

[source,shell]

oikosbot estate collect –owner ORG –out STAGING –max-runs 200 oikosbot estate analyse –staging STAGING –snapshot SNAPSHOT oikosbot estate report –snapshot SNAPSHOT –format json —-

This path is read-only. Workflow API intervals are not invoices or CPU time; energy/carbon/imputed cost remain estimates. DEA is relative to the selected peers, inputs and output proxies—not causal ecological impact. Partial collection fails explicitly; capped histories and old staging files still require review. Snapshots belong outside this source repository, for example in https://github.com/hyperpolymath/oikosbot-estate[oikosbot-estate].

== Layout and checks

crates/:: Rust workspace; oikosbot-fleet is optional and excluded. bot-integration-affine/:: App scaffold, not a deployable substitute for the CLI. analyzers/code-haskell/:: Independent Haskell analyzer. policies/, policy-engine/:: Policy examples/target surfaces; see implementation limits. docs/, .machine_readable/descriptiles/:: Human guides and six core A2ML records. tests/, tools/ci/:: Contract fixtures and verification scripts.

Run cargo test --workspace --locked, cargo fmt --check, and just release-preflight where their toolchains are installed. Missing tools are not passes. Follow link:docs/LAUNCH-READINESS.adoc[the launch review] before promoting any artifact or enabling an enforcement claim.

== Licence and security

MPL-2.0 code; per-file notices remain authoritative. See link:LICENSE[LICENSE], link:LICENSES/[LICENSES], and link:SECURITY.md[private vulnerability reporting].