Skip to content
Arxo Arxo

Licensing

Licensing

Section titled “Licensing”

The arxo-engine may require a valid license for certain use cases. License tier controls which metrics are available. This page describes the licensing model from an integration perspective (no implementation details).

License Tiers

Section titled “License Tiers”

The engine distinguishes:

  • Free — Free tier: only a defined set of metrics are available. Suitable for open source, evaluation, and limited use.
  • Pro — All metrics are available.
  • Enterprise — All metrics plus additional features (if any) for enterprise deployments.

When no valid license is provided (or for OSS/development), the engine typically behaves as Free tier: it runs only free metrics and may filter out others from presets and config.

Free Metrics

Section titled “Free Metrics”

A subset of metrics is designated as free and is always accessible regardless of license. These typically include:

  • Structure: scc, propagation_cost, hierarchy, centrality, modularity
  • Quality: smells, layer_violations, effect_violations
  • Overview: l1_overview, package_metrics, visibility
  • Analysis: flow_analysis, coupling_analysis, monorepo
  • Other: sheaf_cohomology

The exact list is defined by the engine; when you use metric_preset or metrics in config, any metric that is not in the free set may be skipped or require a Pro/Enterprise license.

How the Engine Uses License

Section titled “How the Engine Uses License”
  • Config: You may pass license information via environment (e.g. ARCH0_LICENSE_KEY) or via config/FFI, depending on distribution.
  • Metric filtering: The engine only runs metrics that the current license allows. Requests for Pro-only metrics under a Free license result in those metrics being omitted (no crash).
  • FFI: When using the C-compatible FFI, the engine may accept an optional license key; behavior is the same as above.

For Integrators

Section titled “For Integrators”
  1. Document requirements — Tell your users whether they need a license key and where to set it (e.g. env var).
  2. Handle missing metrics — If you rely on specific metrics, check that they are present in results; under Free tier some may be absent.
  3. Errors — The engine may return a dedicated error (e.g. license invalid/expired) when license validation fails; handle it like other analysis errors in your integration.

Getting a License

Section titled “Getting a License”
  • Free tier / OSS: Often automatic for public open source projects or evaluation; see the main docs or Getting Started for current policy.
  • Trial: Time-limited trial keys may be available for evaluation.
  • Pro / Enterprise: Contact the vendor (e.g. sales@arxo.dev or the contact listed in the official docs) for commercial and enterprise licenses.

Next Steps

Section titled “Next Steps”