Skip to content

Cli

cli

AXM-Audit CLI entry point — Code quality auditing tool.

Usage::

axm-audit audit .
axm-audit audit --json
axm-audit audit --category lint
axm-audit test . --mode=compact
axm-audit version

audit(path='.', *, json_output=False, agent=False, category=None)

Audit a project's code quality against the AXM standard.

Source code in packages/axm-audit/src/axm_audit/cli.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@app.command()
def audit(
    path: Annotated[
        str,
        cyclopts.Parameter(help="Path to project to audit"),
    ] = ".",
    *,
    json_output: Annotated[
        bool,
        cyclopts.Parameter(name=["--json"], help="Output as JSON"),
    ] = False,
    agent: Annotated[
        bool,
        cyclopts.Parameter(name=["--agent"], help="Compact agent-friendly output"),
    ] = False,
    category: Annotated[
        str | None,
        cyclopts.Parameter(name=["--category", "-c"], help="Filter to one category"),
    ] = None,
) -> None:
    """Audit a project's code quality against the AXM standard."""
    from axm_audit.core.auditor import audit_project

    project_path = Path(path).resolve()
    if not project_path.is_dir():
        print(f"❌ Not a directory: {project_path}", file=sys.stderr)
        raise SystemExit(1)

    result = audit_project(project_path, category=category)

    if agent:
        print(json.dumps(format_agent(result), indent=2))
    elif json_output:
        print(json.dumps(format_json(result), indent=2))
    else:
        print(format_report(result))

    if result.quality_score is not None and result.quality_score < PERFECT_SCORE:
        raise SystemExit(1)

main()

Main entry point.

Source code in packages/axm-audit/src/axm_audit/cli.py 
146
147
148
def main() -> None:
    """Main entry point."""
    app()

test(path='.', *, mode='failures', files=None, markers=None, stop_on_first=True, agent=False)

Run tests with agent-optimized structured output.

Source code in packages/axm-audit/src/axm_audit/cli.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
@app.command()
def test(
    path: Annotated[
        str,
        cyclopts.Parameter(help="Path to project to test"),
    ] = ".",
    *,
    mode: Annotated[
        str,
        cyclopts.Parameter(
            name=["--mode"],
            help="Output mode: compact, failures, delta, targeted",
        ),
    ] = "failures",
    files: Annotated[
        list[str] | None,
        cyclopts.Parameter(
            name=["--files"],
            help="Specific test files to run",
        ),
    ] = None,
    markers: Annotated[
        list[str] | None,
        cyclopts.Parameter(
            name=["-m", "--markers"],
            help="Pytest markers to filter",
        ),
    ] = None,
    stop_on_first: Annotated[
        bool,
        cyclopts.Parameter(
            name=["-x", "--stop-on-first"],
            help="Stop on first failure",
        ),
    ] = True,
    agent: Annotated[
        bool,
        cyclopts.Parameter(name=["--agent"], help="Alias for --mode=compact"),
    ] = False,
) -> None:
    """Run tests with agent-optimized structured output."""
    import dataclasses

    from axm_audit.core.test_runner import run_tests

    project_path = Path(path).resolve()
    if not project_path.is_dir():
        print(f"❌ Not a directory: {project_path}", file=sys.stderr)
        raise SystemExit(1)

    effective_mode = "compact" if agent else mode
    report = run_tests(
        project_path,
        mode=effective_mode,  # type: ignore[arg-type]
        files=files,
        markers=markers,
        stop_on_first=stop_on_first,
    )

    print(json.dumps(dataclasses.asdict(report), indent=2))

    if report.failed > 0 or report.errors > 0:
        raise SystemExit(1)

version()

Show axm-audit version.

Source code in packages/axm-audit/src/axm_audit/cli.py 
138
139
140
141
142
143
@app.command()
def version() -> None:
    """Show axm-audit version."""
    from axm_audit import __version__

    print(f"axm-audit {__version__}")