gabriel / muse public
type-contracts.md markdown
6,679 lines 194.1 KB
Raw

Muse — Type Contracts Reference

Auto-generated: 2026-04-12 Source: scripts/gen_type_contracts.py (repo: muse) Check for drift: python scripts/gen_type_contracts.py --check

Do not edit this file manually. It is regenerated from source on every commit. To update, change the source types and re-run the generator.


Table of Contents


Enums

ExitCodemuse/core/errors.py

Standardised CLI exit codes.

Bases: IntEnum

Member Value
SUCCESS 0
USER_ERROR 1
REPO_NOT_FOUND 2
INTERNAL_ERROR 3
NOT_FOUND 4
REMOTE_ERROR 5

TypedDicts

_AgeRecordmuse/cli/commands/age.py

Bases: TypedDict

Field Type Required Default
address str
kind str
file str
born_commit str
born_date str
last_impl_commit str
last_impl_date str
last_change_commit str
last_change_date str
calendar_age_days int
genetic_age_days int
impl_changes int
sig_changes int
renames int
est_survival_pct int

BarAttributionmuse/cli/commands/agent_map.py

Attribution record for one bar.

Bases: TypedDict

Field Type Required Default
bar int
author str
commit_id str
message str

_AnnotateJsonmuse/cli/commands/annotate.py

JSON output of muse annotate [--json].

Bases: TypedDict

Field Type Required Default
commit_id str
message str
branch str
author str
committed_at str
reviewed_by list[str]
test_runs int
changed bool
dry_run bool

_PublicSymbolDictmuse/cli/commands/api_surface.py

JSON-serialisable form of a :class:_PublicSymbol.

Bases: TypedDict

Field Type Required Default
address str
kind str
name str
qualified_name str
language str
content_id str
signature_id str
body_hash str

_ArchiveJsonmuse/cli/commands/archive.py

Machine-readable output of muse archive --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | path | str | ✓ | | | format | str | ✓ | | | file_count | int | ✓ | | | bytes | int | ✓ | | | commit_id | str | ✓ | | | message | str | ✓ | | | branch | str | ✓ | | | ref | str | None | ✓ | |

_CheckJsonmuse/cli/commands/attributes.py

JSON output of muse attributes check.

Bases: TypedDict

Field Type Required Default
results list[_CheckResultJson]

_CheckResultJsonmuse/cli/commands/attributes.py

JSON result for a single path resolution.

Bases: TypedDict

Field Type Required Default
path str
dimension str
strategy str
rule_index int

_ListJsonmuse/cli/commands/attributes.py

JSON output of muse attributes list.

Bases: TypedDict

Field Type Required Default
domain str
rules list[_RuleJson]

_RuleJsonmuse/cli/commands/attributes.py

JSON representation of a single .museattributes rule.

Bases: TypedDict

Field Type Required Default
path_pattern str
dimension str
strategy str
comment str
priority int
source_index int

_ValidateErrorJsonmuse/cli/commands/attributes.py

A single validation error entry.

Bases: TypedDict

Field Type Required Default
kind str
message str

_ValidateJsonmuse/cli/commands/attributes.py

JSON output of muse attributes validate.

Bases: TypedDict

Field Type Required Default
valid bool
errors list[_ValidateErrorJson]

_ChallengeRespmuse/cli/commands/auth.py

Parsed response from the hub challenge endpoint.

Bases: TypedDict

Field Type Required Default
challengeToken str
challenge_token str
isNewKey bool
is_new_key bool

_JsonPayloadmuse/cli/commands/auth.py

Generic JSON request payload for hub auth endpoints (all fields optional str).

Bases: TypedDict

Field Type Required Default
fingerprint str
algorithm str
challenge_token str
public_key_b64 str
signature_b64 str
handle str
label str

_KeygenJsonmuse/cli/commands/auth.py

JSON schema for muse auth keygen --json.

Bases: TypedDict

Field Type Required Default
status str
hub str
hostname str
hd_path str
public_key_b64 str
fingerprint str

_LogoutJsonmuse/cli/commands/auth.py

JSON schema for muse auth logout --json.

Bases: TypedDict

Field Type Required Default
status str
hubs list[str]
count int

_RegisterJsonmuse/cli/commands/auth.py

JSON schema for muse auth register --json.

Bases: TypedDict

Field Type Required Default
status str
hub str
handle str
identity_id str
identity_type str
fingerprint str
token_stored bool
identity_path str

_VerifyRespmuse/cli/commands/auth.py

Parsed response from the hub verify endpoint.

Bases: TypedDict

Field Type Required Default
handle str
identityId str
identity_id str
isNewIdentity bool
is_new_identity bool

_WhoamiJsonmuse/cli/commands/auth.py

JSON schema for muse auth whoami --json (per-identity entry).

Bases: TypedDict

Field Type Required Default
hub str
type str
handle str
fingerprint str
key_set bool
capabilities list[str]

_BisectLogJsonmuse/cli/commands/bisect.py

JSON output for muse bisect log --json.

Bases: TypedDict

Field Type Required Default
active bool
entries list[str]

_BisectResetJsonmuse/cli/commands/bisect.py

JSON output for muse bisect reset --json.

Bases: TypedDict

Field Type Required Default
reset bool

_BisectRunDoneJsonmuse/cli/commands/bisect.py

Final NDJSON line emitted by muse bisect run --json when complete.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | done | bool | ✓ | | | first_bad | str | None | ✓ | | | steps_taken | int | ✓ | |

_BisectRunStepJsonmuse/cli/commands/bisect.py

One NDJSON line emitted by muse bisect run --json per step.

Bases: TypedDict

Field Type Required Default
step int
testing str
verdict str
remaining_count int
done bool

_BisectStepJsonmuse/cli/commands/bisect.py

JSON output for start / bad / good / skip subcommands.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | done | bool | ✓ | | | first_bad | str | None | ✓ | | | next_to_test | str | None | ✓ | | | remaining_count | int | ✓ | | | steps_remaining | int | ✓ | | | verdict | str | ✓ | | | symbol_changes | list[str] | ✓ | |

_BlameEventJsonmuse/cli/commands/blame.py

One event in the blame history of a symbol.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | event | SymbolEventKind | ✓ | | | commit_id | str | ✓ | | | author | str | ✓ | | | message | str | ✓ | | | committed_at | str | ✓ | | | address | str | ✓ | | | detail | str | ✓ | | | new_address | str | None | ✓ | |

_BlameResultJsonmuse/cli/commands/blame.py

Top-level JSON output of muse code blame --json.

Bases: TypedDict

Field Type Required Default
address str
start_ref str
total_commits_scanned int
truncated bool
events list[_BlameEventJson]

_BlastRiskFiltersmuse/cli/commands/blast_risk.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | kind | str | None | ✓ | | | file | str | None | ✓ | | | min_risk | int | ✓ | | | since | str | None | ✓ | | | top | int | ✓ | | | max_commits | int | ✓ | |

_BlastRiskOutputmuse/cli/commands/blast_risk.py

JSON payload for muse code blast-risk output.

Bases: TypedDict

Field Type Required Default
ref str
commits_analysed int
truncated bool
filters _BlastRiskFilters
weights _BlastRiskWeights
symbols list[_SymbolRiskJson]

_BlastRiskWeightsmuse/cli/commands/blast_risk.py

Bases: TypedDict

Field Type Required Default
impact float
churn float
test_gap float
coupling float

_SymbolRiskmuse/cli/commands/blast_risk.py

Fully-scored risk record for one symbol.

Bases: TypedDict

Field Type Required Default
address str
kind str
file str
risk int
impact_raw int
churn_raw int
test_gap_raw float
coupling_raw int
impact_score int
churn_score int
test_gap_score int
coupling_score int
production_callers list[str]
test_callers list[str]

_SymbolRiskJsonmuse/cli/commands/blast_risk.py

JSON-serialisable risk record — production_callers/test_callers excluded.

Bases: TypedDict

Field Type Required Default
address str
kind str
file str
risk int
impact_raw int
churn_raw int
test_gap_raw float
coupling_raw int
impact_score int
churn_score int
test_gap_score int
coupling_score int

_BreakageIssuemuse/cli/commands/breakage.py

One breakage finding, serialisable to JSON.

Bases: TypedDict

Field Type Required Default
issue_type str
file_path str
description str
severity str

_BundleCreateJsonmuse/cli/commands/bundle.py

JSON output for muse bundle create --json.

Bases: TypedDict

Field Type Required Default
file str
commits int
objects int
size_bytes int
branches list[str]

_BundleUnbundleJsonmuse/cli/commands/bundle.py

JSON output for muse bundle unbundle --json.

Bases: TypedDict

Field Type Required Default
commits_written int
snapshots_written int
objects_written int
objects_skipped int
refs_updated list[str]

_BundleVerifyJsonmuse/cli/commands/bundle.py

JSON output for muse bundle verify --json.

Bases: TypedDict

Field Type Required Default
objects_checked int
snapshots_checked int
all_ok bool
failures list[str]

CatErrormuse/cli/commands/cat.py

A failed lookup returned in --json mode.

Bases: TypedDict

Field Type Required Default
address str
error str
error_code str
hint str

CatResultmuse/cli/commands/cat.py

One resolved symbol returned in --json mode.

Bases: TypedDict

Field Type Required Default
address str
file_path str
symbol str
kind str
lineno int
end_lineno int
source str
source_ref str

_CheckJsonmuse/cli/commands/check.py

Machine-readable output of muse check --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | domain | str | ✓ | | | rules_checked | int | ✓ | | | has_errors | bool | ✓ | | | has_warnings | bool | ✓ | | | error_count | int | ✓ | | | warning_count | int | ✓ | | | info_count | int | ✓ | | | total_violations | int | ✓ | | | violations | list[dict] | ✓ | | | base_commit_id | str | None | ✓ | | | elapsed_seconds | float | ✓ | |

_CleanResultJsonmuse/cli/commands/clean.py

JSON output for muse clean.

Bases: TypedDict

Field Type Required Default
status str
removed list[str]
dirs_removed list[str]
count int
dry_run bool

_CloneJsonmuse/cli/commands/clone.py

Stable JSON schema emitted by muse clone --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | url | str | ✓ | | | directory | str | ✓ | | | branch | str | ✓ | | | commits_received | int | ✓ | | | objects_written | int | ✓ | | | head | str | None | ✓ | | | domain | str | ✓ | | | dry_run | bool | ✓ | |

_ClusterDictmuse/cli/commands/clones.py

Bases: TypedDict

Field Type Required Default
tier str
hash str
count int
members list[_MemberDict]

_FileHotspotmuse/cli/commands/clones.py

Bases: TypedDict

Field Type Required Default
file str
clone_symbols int

_MemberDictmuse/cli/commands/clones.py

Bases: TypedDict

Field Type Required Default
address str
kind str
language str
body_hash str
signature_id str
content_id str

_CommitRefmuse/cli/commands/compare.py

Bases: TypedDict

Field Type Required Default
commit_id str
message str

_CompareFiltersmuse/cli/commands/compare.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | kind | str | None | ✓ | | | file | str | None | ✓ | | | language | str | None | ✓ | |

_CompareStatmuse/cli/commands/compare.py

Bases: TypedDict

Field Type Required Default
files_changed int
symbols_added int
symbols_removed int
symbols_modified int
semver_impact str

_OpSummarymuse/cli/commands/compare.py

Bases: TypedDict

Field Type Required Default
op str
address str
detail str

_GetJsonmuse/cli/commands/config_cmd.py

JSON schema for muse config get --json.

Bases: TypedDict

Field Type Required Default
key str
value str

_SetJsonmuse/cli/commands/config_cmd.py

JSON schema for muse config set --json.

Bases: TypedDict

Field Type Required Default
status str
key str
value str

GrepFileResultmuse/cli/commands/content_grep.py

All matches within a single file.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | path | str | ✓ | | | object_id | str | None | ✓ | | | match_count | int | ✓ | | | matches | list[GrepMatch] | ✓ | |

GrepMatchmuse/cli/commands/content_grep.py

A single matching line within a file, with optional surrounding context.

Bases: TypedDict

Field Type Required Default
line_number int
text str
context_before list[str]
context_after list[str]

_ContentGrepJsonmuse/cli/commands/content_grep.py

Top-level JSON envelope for muse content-grep --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | source | str | ✓ | | | commit_id | str | None | ✓ | | | snapshot_id | str | None | ✓ | | | pattern | str | ✓ | | | total_files_matched | int | ✓ | | | total_matches | int | ✓ | | | results | list[GrepFileResult] | ✓ | |

_ArgObsmuse/cli/commands/contract.py

Observed argument patterns at call sites for one positional slot.

Bases: TypedDict

Field Type Required Default
param_index int
categories _CounterMap
none_count int
always_provided bool
omit_count int

_CommitSignalmuse/cli/commands/contract.py

Bases: TypedDict

Field Type Required Default
bump str
message str
date str

_ContractJsonmuse/cli/commands/contract.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | address | str | ✓ | | | name | str | ✓ | | | kind | str | ✓ | | | signature | str | ✓ | | | parameters | list[_ParamInfo] | ✓ | | | return_annotation | str | None | ✓ | | | call_sites | int | ✓ | | | caller_files | int | ✓ | | | return_dispositions | _CounterMap | ✓ | | | arg_observations | list[_ArgObs] | ✓ | | | test_assertions | list[str] | ✓ | | | commit_signals | list[_CommitSignal] | ✓ | | | history | _HistorySummary | ✓ | | | preconditions | list[str] | ✓ | | | postconditions | list[str] | ✓ | | | warnings | list[str] | ✓ | | | stability | str | ✓ | |

_HistorySummarymuse/cli/commands/contract.py

Bases: TypedDict

Field Type Required Default
commits_analysed int
truncated bool
major_bumps int
minor_bumps int
patch_bumps int
sig_changes int
impl_changes int
est_survival_pct int

_ParamInfomuse/cli/commands/contract.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | annotation | str | None | ✓ | | | has_default | bool | ✓ | | | default_str | str | None | ✓ | |

_CoverageFiltersmuse/cli/commands/coverage.py

Bases: TypedDict

Field Type Required Default
exclude_dunder bool
exclude_private bool
min_callers int
exclude_self bool

_CoveragePayloadmuse/cli/commands/coverage.py

JSON payload for muse code coverage output.

Bases: TypedDict

Field Type Required Default
address str
commit_id str
total_methods int
covered int
percent float
filters _CoverageFilters
methods list[_MethodJson]
compare_commit_id str
newly_covered list[str]
newly_uncovered list[str]
percent_change float

_MethodJsonmuse/cli/commands/coverage.py

Bases: TypedDict

Field Type Required Default
address str
name str
called bool
callers list[str]

_DeadCandidateJsonmuse/cli/commands/dead.py

JSON-serialisable representation of one dead-code candidate.

Bases: TypedDict

Field Type Required Default
address str
file_path str
kind str
referenced bool
module_imported bool
confidence str
reason str

_DeadPayloadmuse/cli/commands/dead.py

JSON payload for muse code dead output.

Bases: TypedDict

Field Type Required Default
source str
total_files_scanned int
total_symbols_scanned int
elapsed_seconds float
high_confidence_count int
medium_confidence_count int
results list[_DeadCandidateJson]
compare_commit_id str
new_dead list[_DeadCandidateJson]
recovered list[_DeadCandidateJson]
net_change int

_ScanKwargsmuse/cli/commands/dead.py

Keyword arguments forwarded to every :func:_scan_file_bytes call.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | kind_filter | str | None | ✓ | | | max_file_bytes | int | ✓ | | | workers | int | ✓ | | | language_filter | str | None | ✓ | | | path_filter | str | None | ✓ | | | exclude_tests | bool | ✓ | | | exclude_private | bool | ✓ | | | high_confidence_only | bool | ✓ | | | allowlist | frozenset[str] | ✓ | |

_DescribeJsonmuse/cli/commands/describe.py

JSON output for muse describe.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | tag | str | None | ✓ | | | distance | int | ✓ | | | short_sha | str | ✓ | | | name | str | ✓ | | | exact | bool | ✓ | | | repo_id | str | ✓ | | | branch | str | ✓ | |

DocCiConfigmuse/cli/commands/docs_cmd.py

Configuration for the documentation quality CI gate.

Bases: TypedDict

Field Type Required Default
min_avg_health float
max_undocumented int
max_stale int
fail_on_breaking_undocumented bool

DocCiGateResultmuse/cli/commands/docs_cmd.py

Result of a single documentation CI gate check.

Bases: TypedDict

Field Type Required Default
name str
passed bool
message str

DocCiResultmuse/cli/commands/docs_cmd.py

Overall result of the documentation CI gate.

Bases: TypedDict

Field Type Required Default
passed bool
gates list[DocCiGateResult]
summary DocSummary

_ChangelogJsonmuse/cli/commands/docs_cmd.py

JSON representation of a :class:ChangelogReport.

Bases: TypedDict

Field Type Required Default
from_ref str
to_ref str
added list[str]
removed list[str]
changed list[str]
breaking list[str]

_DocCiGateJsonmuse/cli/commands/docs_cmd.py

Bases: TypedDict

Field Type Required Default
name str
passed bool
message str

_DocCiJsonmuse/cli/commands/docs_cmd.py

Bases: TypedDict

Field Type Required Default
passed bool
gates list[_DocCiGateJson]
summary DocSummary

_HistoryEventJsonmuse/cli/commands/docs_cmd.py

JSON representation of one symbol version event.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | committed_at | str | ✓ | | | op | str | ✓ | | | version | str | None | ✓ | | | sem_ver_bump | str | None | ✓ | | | breaking | bool | ✓ | |

_SymbolHistoryJsonmuse/cli/commands/docs_cmd.py

JSON representation of a symbol's full history.

Bases: TypedDict

Field Type Required Default
address str
events list[_HistoryEventJson]

_Capabilitiesmuse/cli/commands/domains.py

Capability manifest sent to MuseHub on domain publish.

Bases: TypedDict

Field Type Required Default
dimensions list[_DimensionDef]
artifact_types list[str]
merge_semantics str
supported_commands list[str]

_DimensionDefmuse/cli/commands/domains.py

One semantic dimension exported by a domain plugin.

Bases: TypedDict

Field Type Required Default
name str
description str

_DomainEntryJsonBasemuse/cli/commands/domains.py

Required keys present on every domain JSON entry.

Bases: TypedDict

Field Type Required Default
domain str
module_path str
capabilities list[str]
active bool

_PublishPayloadmuse/cli/commands/domains.py

Wire payload for POST /api/v1/domains on MuseHub.

Bases: TypedDict

Field Type Required Default
author_slug str
slug str
display_name str
description str
capabilities _Capabilities
viewer_type str
version str

_PublishResponsemuse/cli/commands/domains.py

Parsed response body from POST /api/v1/domains.

Bases: TypedDict

Field Type Required Default
domain_id str
scoped_id str
manifest_hash str

_ScaffoldJsonmuse/cli/commands/domains.py

Structured result from muse domains --new <name> --json.

Bases: TypedDict

Field Type Required Default
name str
class_name str
path str
status str

_SchemaInfoJsonmuse/cli/commands/domains.py

Schema block embedded in a domain's JSON entry.

Bases: TypedDict

Field Type Required Default
schema_version str
merge_mode str
description str
dimensions list[_DimensionDef]

_UseJsonmuse/cli/commands/domains.py

Result from muse domains use <name> --json.

Bases: TypedDict

Field Type Required Default
domain str
repo str
status str

_ValidateCheckJsonmuse/cli/commands/domains.py

One protocol compliance check from muse domains validate.

Bases: TypedDict

Field Type Required Default
name str
ok bool
detail str

_ValidateJsonmuse/cli/commands/domains.py

Full result from muse domains validate [<name>] --json.

Bases: TypedDict

Field Type Required Default
domain str
ok bool
checks list[_ValidateCheckJson]

_EntangledPairmuse/cli/commands/entangle.py

Bases: TypedDict

Field Type Required Default
symbol_a str
symbol_b str
file_a str
file_b str
same_file bool
structurally_linked bool
co_changes int
commits_both_active int
co_change_rate float
a_in_test bool
b_in_test bool

_FetchJsonmuse/cli/commands/fetch.py

Top-level JSON object emitted by muse fetch --json.

Bases: TypedDict

Field Type Required Default
results list[_RemoteResultJson]
dry_run bool

_RemoteResultJsonmuse/cli/commands/fetch.py

Per-remote/branch result inside a muse fetch --json response.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | remote | str | ✓ | | | branch | str | ✓ | | | status | str | ✓ | | | commits_received | int | ✓ | | | objects_written | int | ✓ | | | head | str | None | ✓ | | | pruned | list[str] | ✓ | | | dry_run | bool | ✓ | |

PhraseMatchmuse/cli/commands/find_phrase.py

A commit that contains the searched phrase.

Bases: TypedDict

Field Type Required Default
score float
commit_id str
author str
message str

_GcJsonmuse/cli/commands/gc.py

Machine-readable output of muse gc --json.

Bases: TypedDict

Field Type Required Default
collected_count int
collected_bytes int
reachable_count int
commits_reachable int
commits_collected int
commits_collected_bytes int
snapshots_reachable int
snapshots_collected int
snapshots_collected_bytes int
elapsed_seconds float
grace_period_seconds int
dry_run bool
full bool
collected_ids list[str]

_FilterSpecmuse/cli/commands/gravity.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | kind | str | None | ✓ | | | file | str | None | ✓ | | | min_gravity | float | ✓ | | | top | int | ✓ | |

_JsonOutmuse/cli/commands/gravity.py

Bases: TypedDict

Field Type Required Default
ref str
snapshot_id str
total_production_symbols int
max_depth int
include_tests bool
filters _FilterSpec
symbols list[_SymbolGravity]

_SymbolGravitymuse/cli/commands/gravity.py

Gravity record for a single production symbol.

Bases: TypedDict

Field Type Required Default
address str
name str
kind str
file str
gravity_pct float
direct_dependents int
transitive_dependents int
max_depth int
depth_distribution _CounterMap

_ConnectJsonmuse/cli/commands/hub.py

JSON schema for muse hub connect --json.

Bases: TypedDict

Field Type Required Default
status str
hub_url str
hostname str
authenticated bool
identity_name str
identity_type str

_DisconnectJsonmuse/cli/commands/hub.py

JSON schema for muse hub disconnect --json.

Bases: TypedDict

Field Type Required Default
status str
hub_url str
hostname str

_HubApiResponsemuse/cli/commands/hub.py

Generic MuseHub API response envelope (all keys optional).

Bases: TypedDict

Field Type Required Default
repo_id str
repos list[_RepoEntry]
proposals list[_ProposalEntry]

_LabelEntrymuse/cli/commands/hub.py

One label row returned by the MuseHub labels API.

Bases: TypedDict

Field Type Required Default
label_id str
repo_id str
name str
color str
description str

_PingJsonmuse/cli/commands/hub.py

JSON schema for muse hub ping --json.

Bases: TypedDict

Field Type Required Default
status str
hub_url str
hostname str
reachable bool
message str

_ProposalEntrymuse/cli/commands/hub.py

A single proposal entry returned by the MuseHub proposals API.

Bases: TypedDict

Field Type Required Default
proposalId str
title str
state str
fromBranch str
toBranch str
author str
createdAt str

_RepoEntrymuse/cli/commands/hub.py

A single repo entry returned by the MuseHub search/list API.

Bases: TypedDict

Field Type Required Default
owner str
slug str
repoId str

_RepoJsonmuse/cli/commands/hub.py

JSON schema for muse hub repo create --json.

Bases: TypedDict

Field Type Required Default
repo_id str
name str
owner str
slug str
visibility str
description str
clone_url str
tags list[str]
created_at str

_StatusJsonmuse/cli/commands/hub.py

JSON schema for muse hub status --json.

Bases: TypedDict

Field Type Required Default
hub_url str
hostname str
authenticated bool
identity_type str
identity_name str
identity_id str
capabilities list[str]

_EntryPointJsonmuse/cli/commands/impact.py

One framework entry-point edge in JSON output.

Bases: TypedDict

Field Type Required Default
framework_id str
kind str
metadata _StrMeta

_ImpactJsonmuse/cli/commands/impact.py

JSON payload for muse code impact output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | mode | str | ✓ | | | address | str | ✓ | | | target_name | str | ✓ | | | commit_id | str | ✓ | | | depth_limit | int | ✓ | | | file_filter | str | None | ✓ | | | blast_radius | _BlastRadius | ✓ | | | total | int | ✓ | | | entry_points | list[_EntryPointJson] | ✓ | | | compare_commit_id | str | ✓ | | | added_callers | list[str] | ✓ | | | removed_callers | list[str] | ✓ | | | net_change | int | ✓ | |

_RebuildResultmuse/cli/commands/index_rebuild.py

Bases: TypedDict

Field Type Required Default
schema_version str
dry_run bool
rebuilt list[str]
symbol_history_addresses int
symbol_history_events int
hash_occurrence_clusters int
hash_occurrence_addresses int

ChannelInfomuse/cli/commands/instrumentation.py

Statistics for one MIDI channel.

Bases: TypedDict

Field Type Required Default
channel int
note_count int
pitch_min int
pitch_max int
pitch_min_name str
pitch_max_name str
register str
mean_velocity float

_DiffEntrymuse/cli/commands/languages.py

Bases: TypedDict

Field Type Required Default
language str
delta_files int
delta_symbols int
files_before int
files_after int
symbols_before int
symbols_after int
status str

_LangEntrymuse/cli/commands/languages.py

Bases: TypedDict

Field Type Required Default
language str
files int
symbols int
kinds LangCount

_FiltersEntrymuse/cli/commands/list_coord.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | run_id | str | None | ✓ | | | branch | str | None | ✓ | | | address_glob | str | None | ✓ | | | operation | str | None | ✓ | | | include_expired | bool | ✓ | | | kind | str | ✓ | | | limit | int | None | ✓ | |

_IntentEntrymuse/cli/commands/list_coord.py

Bases: TypedDict

Field Type Required Default
intent_id str
reservation_id str
run_id str
branch str
addresses list[str]
operation str
created_at str
detail str

_ListJsonmuse/cli/commands/list_coord.py

Bases: TypedDict

Field Type Required Default
active_reservations int
expired_reservations int
released_reservations int
total_reservations_shown int
total_intents_shown int
has_conflicts bool
filters _FiltersEntry
reservations list[_ReservationEntry]
intents list[_IntentEntry]
elapsed_seconds float

_ReservationEntrymuse/cli/commands/list_coord.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | reservation_id | str | ✓ | | | run_id | str | ✓ | | | branch | str | ✓ | | | addresses | list[str] | ✓ | | | created_at | str | ✓ | | | expires_at | str | ✓ | | | effective_expires_at | str | ✓ | | | ttl_remaining_seconds | float | ✓ | | | operation | str | None | ✓ | | | is_active | bool | ✓ | | | released | bool | ✓ | | | conflict_count | int | ✓ | |

_CommitJsonmuse/cli/commands/log.py

Stable JSON wire format for a single commit in muse log --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | branch | str | ✓ | | | message | str | ✓ | | | author | str | ✓ | | | agent_id | str | ✓ | | | model_id | str | ✓ | | | committed_at | str | ✓ | | | parent_commit_id | str | None | ✓ | | | parent2_commit_id | str | None | ✓ | | | snapshot_id | str | None | ✓ | | | sem_ver_bump | str | None | ✓ | | | breaking_changes | list[str] | ✓ | | | metadata | Metadata | ✓ | | | files_added | list[str] | ✓ | | | files_removed | list[str] | ✓ | | | files_modified | list[str] | ✓ | | | structured_delta | dict | None | ✓ | |

_EventRecordmuse/cli/commands/narrative.py

A single event in a symbol's life.

Bases: TypedDict

Field Type Required Default
date str
commit_id str
commit_msg str
event_type str
sem_ver_bump str
detail str

_NarrativeJsonmuse/cli/commands/narrative.py

Top-level JSON output structure.

Bases: TypedDict

Field Type Required Default
address str
name str
kind str
file str
status str
born_date str
born_commit str
last_change_date str
last_change_commit str
last_impl_date str
last_impl_commit str
calendar_age_days int
genetic_age_days int
impl_changes int
sig_changes int
renames int
est_survival_pct int
commits_analysed int
truncated bool
events list[_EventRecord]

_MergeItemDictmuse/cli/commands/plan_merge.py

JSON-serialisable form of a :class:_MergeItem.

Bases: TypedDict

Field Type Required Default
address str
conflict_type str
ours_change str
theirs_change str
recommendation str

_PathResultmuse/cli/commands/plumbing/check_attr.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | path | str | ✓ | | | dimension | str | ✓ | | | strategy | str | ✓ | | | rule | _RuleDict | None | ✓ | |

_RuleDictmuse/cli/commands/plumbing/check_attr.py

Bases: TypedDict

Field Type Required Default
path_pattern str
dimension str
strategy str
comment str
priority int
source_index int

_PathResultmuse/cli/commands/plumbing/check_ignore.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | path | str | ✓ | | | ignored | bool | ✓ | | | matching_pattern | str | None | ✓ | |

_CheckRefFormatResultmuse/cli/commands/plumbing/check_ref_format.py

Bases: TypedDict

Field Type Required Default
results list[_CheckResult]
all_valid bool
valid_count int
invalid_count int

_CheckResultmuse/cli/commands/plumbing/check_ref_format.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | valid | bool | ✓ | | | error | str | None | ✓ | |

_RulesDictmuse/cli/commands/plumbing/check_ref_format.py

Bases: TypedDict

Field Type Required Default
max_length int
forbidden_chars list[str]
forbidden_patterns list[str]
notes str

_CommitNodemuse/cli/commands/plumbing/commit_graph.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | parent_commit_id | str | None | ✓ | | | parent2_commit_id | str | None | ✓ | | | message | str | ✓ | | | branch | str | ✓ | | | committed_at | str | ✓ | | | snapshot_id | str | ✓ | | | author | str | ✓ | |

_CapabilitiesDictmuse/cli/commands/plumbing/domain_info.py

Bases: TypedDict

Field Type Required Default
structured_merge bool
crdt bool

_ForEachRefResultmuse/cli/commands/plumbing/for_each_ref.py

Bases: TypedDict

Field Type Required Default
refs list[_RefDetail]
count int

_RefDetailmuse/cli/commands/plumbing/for_each_ref.py

One ref entry.

Bases: TypedDict

Field Type Required Default
ref str
branch str
commit_id str
author str
message str
committed_at str
snapshot_id str

_NameRevEntrymuse/cli/commands/plumbing/name_rev.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | None | ✓ | | | input | str | ✓ | | | name | str | None | ✓ | | | branch | str | None | ✓ | | | distance | int | None | ✓ | | | undefined | bool | ✓ | | | ambiguous | bool | ✓ | |

_SnapshotOutputmuse/cli/commands/plumbing/read_snapshot.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
created_at str
file_count int
manifest Manifest

_HeadInfomuse/cli/commands/plumbing/show_ref.py

Bases: TypedDict

Field Type Required Default
ref str
branch str
commit_id str

_RefEntrymuse/cli/commands/plumbing/show_ref.py

Bases: TypedDict

Field Type Required Default
ref str
commit_id str

_ShowRefResultmuse/cli/commands/plumbing/show_ref.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | refs | list[_RefEntry] | ✓ | | | head | _HeadInfo | None | ✓ | | | count | int | ✓ | |

_AddedEntrymuse/cli/commands/plumbing/snapshot_diff.py

Bases: TypedDict

Field Type Required Default
path str
object_id str

_DeletedEntrymuse/cli/commands/plumbing/snapshot_diff.py

Bases: TypedDict

Field Type Required Default
path str
object_id str

_DiffResultmuse/cli/commands/plumbing/snapshot_diff.py

Bases: TypedDict

Field Type Required Default
snapshot_a str
snapshot_b str
added list[_AddedEntry]
modified list[_ModifiedEntry]
deleted list[_DeletedEntry]
total_changes int

_ModifiedEntrymuse/cli/commands/plumbing/snapshot_diff.py

Bases: TypedDict

Field Type Required Default
path str
object_id_a str
object_id_b str

_SymbolicRefResultmuse/cli/commands/plumbing/symbolic_ref.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | ref | str | ✓ | | | symbolic_target | str | None | ✓ | | | branch | str | None | ✓ | | | commit_id | str | None | ✓ | | | detached | bool | ✓ | |

_ObjectResultmuse/cli/commands/plumbing/verify_object.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | object_id | str | ✓ | | | ok | bool | ✓ | | | size_bytes | int | None | ✓ | | | error | str | None | ✓ | |

_Failuremuse/cli/commands/plumbing/verify_pack.py

Bases: TypedDict

Field Type Required Default
kind str
id str
error str

_StatResultmuse/cli/commands/plumbing/verify_pack.py

Bases: TypedDict

Field Type Required Default
objects int
snapshots int
commits int

_VerifyPackResultmuse/cli/commands/plumbing/verify_pack.py

Bases: TypedDict

Field Type Required Default
objects_checked int
snapshots_checked int
commits_checked int
all_ok bool
failures list[_Failure]

_PartnerRecordmuse/cli/commands/predict.py

Bases: TypedDict

Field Type Required Default
address str
co_change_rate float
co_change_commits int

_PredictJsonmuse/cli/commands/predict.py

Bases: TypedDict

Field Type Required Default
generated_at str
horizon_commits int
max_commits int
commits_analysed int
truncated bool
predictions list[_PredictionRecord]

_PredictionRecordmuse/cli/commands/predict.py

Bases: TypedDict

Field Type Required Default
address str
name str
kind str
file str
score float
confidence str
reasons list[str]
signals _SignalSet
last_changed_commit str
last_changed_date str
top_partners list[_PartnerRecord]

_SignalSetmuse/cli/commands/predict.py

Bases: TypedDict

Field Type Required Default
recency float
frequency float
co_change float
sig_instability float
module_velocity float

_PullJsonmuse/cli/commands/pull.py

Stable JSON schema emitted by muse pull --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | remote | str | ✓ | | | branch | str | ✓ | | | local_branch | str | ✓ | | | commits_received | int | ✓ | | | objects_written | int | ✓ | | | head | str | None | ✓ | | | conflict_paths | list[str] | ✓ | | | dry_run | bool | ✓ | |

_PushJsonmuse/cli/commands/push.py

Stable JSON schema for push output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | remote | str | ✓ | | | branch | str | ✓ | | | head | str | None | ✓ | | | commits_sent | int | ✓ | | | objects_sent | int | ✓ | | | force | bool | ✓ | | | dry_run | bool | ✓ | |

_RebaseDryRunCommitJsonmuse/cli/commands/rebase.py

One entry in the --dry-run commits list.

Bases: TypedDict

Field Type Required Default
commit_id str
message str

_RebaseDryRunJsonmuse/cli/commands/rebase.py

JSON output for muse rebase --dry-run.

Bases: TypedDict

Field Type Required Default
branch str
onto str
commits list[_RebaseDryRunCommitJson]
count int
squash bool

_RebaseResultJsonmuse/cli/commands/rebase.py

JSON output for a completed rebase (normal or squash).

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | branch | str | ✓ | | | new_head | str | None | ✓ | | | onto | str | ✓ | | | squash | bool | ✓ | | | replayed | int | ✓ | | | conflicts | list[str] | ✓ | |

_RebaseStatusJsonmuse/cli/commands/rebase.py

JSON output for muse rebase --status.

Bases: TypedDict

Field Type Required Default
active bool
original_branch str
original_head str
onto str
total int
done int
remaining int
squash bool

_ReflogAllJsonmuse/cli/commands/reflog.py

JSON object returned by muse reflog --all --json.

Bases: TypedDict

Field Type Required Default
refs list[str]
count int

_ReflogEntryJsonmuse/cli/commands/reflog.py

One entry in the JSON reflog output.

Bases: TypedDict

Field Type Required Default
index int
new_id str
old_id str
timestamp str
operation str
author str

_ReflogResultJsonmuse/cli/commands/reflog.py

Top-level JSON object returned by muse reflog --json.

Bases: TypedDict

Field Type Required Default
ref str
total int
limit int
entries list[_ReflogEntryJson]

_ReleaseDeleteJsonmuse/cli/commands/release.py

JSON output for muse release delete.

Bases: TypedDict

Field Type Required Default
status str
tag str
was_draft bool
remote_retracted bool
dry_run bool

_ReleasePushJsonmuse/cli/commands/release.py

JSON output for muse release push.

Bases: TypedDict

Field Type Required Default
status str
tag str
remote str
release_id str
dry_run bool

_RemoteEntryJsonmuse/cli/commands/remote.py

Single remote entry in muse remote --json list output.

Bases: TypedDict

Field Type Required Default
name str
url str
tracking str
head str

_RemoteGetUrlJsonmuse/cli/commands/remote.py

JSON schema for muse remote get-url.

Bases: TypedDict

Field Type Required Default
name str
url str

_RemoteListJsonmuse/cli/commands/remote.py

JSON schema for muse remote [--json].

Bases: TypedDict

Field Type Required Default
remotes list[_RemoteEntryJson]

_RemoteMutationJsonmuse/cli/commands/remote.py

JSON schema for add / remove / rename / set-url subcommands.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | name | str | ✓ | | | url | str | None | ✓ | | | old_url | str | None | ✓ | | | old_name | str | None | ✓ | | | new_name | str | None | ✓ | |

_RemoteStatusJsonmuse/cli/commands/remote.py

JSON schema for muse remote status.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | remote | str | ✓ | | | url | str | ✓ | | | server_root | str | ✓ | | | reachable | bool | ✓ | | | http_status | int | None | ✓ | | | message | str | ✓ | | | tracked_refs | _RefMap | ✓ | |

_EditSitemuse/cli/commands/rename.py

A single token replacement site.

Bases: TypedDict

Field Type Required Default
file str
line int
col_start int
col_end int
kind str
context str

_RenameResultmuse/cli/commands/rename.py

Machine-readable summary of a rename operation.

Bases: TypedDict

Field Type Required Default
from_address str
to_address str
from_name str
to_name str
scope str
dry_run bool
files_to_modify list[str]
total_edit_sites int
edit_sites list[_EditSite]
warnings list[str]

_RmResultJsonmuse/cli/commands/rm.py

JSON output for muse rm.

Bases: TypedDict

Field Type Required Default
status str
removed list[str]
cached bool
dry_run bool
count int

_PickResultDictmuse/cli/commands/semantic_cherry_pick.py

JSON schema for one cherry-pick result.

Bases: TypedDict

Field Type Required Default
address str
status str
detail str
old_lines int
new_lines int
diff_lines list[str]
verified bool

_FileCovmuse/cli/commands/semantic_test_coverage.py

Aggregated coverage record for one production file.

Bases: TypedDict

Field Type Required Default
file str
total_symbols int
covered_symbols int
uncovered_symbols int
coverage_pct float
symbols list[_SymbolCov]

_FilterSpecmuse/cli/commands/semantic_test_coverage.py

Filters applied to this analysis run.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | file | str | None | ✓ | | | kind | str | None | ✓ | | | min_coverage | int | None | ✓ | | | uncovered_only | bool | ✓ | |

_JsonOutmuse/cli/commands/semantic_test_coverage.py

Top-level JSON output structure.

Bases: TypedDict

Field Type Required Default
ref str
snapshot_id str
depth int
transitive bool
filters _FilterSpec
summary _SummarySpec
files list[_FileCov]

_SummarySpecmuse/cli/commands/semantic_test_coverage.py

Aggregate statistics across all production files.

Bases: TypedDict

Field Type Required Default
total_symbols int
covered_symbols int
uncovered_symbols int
coverage_pct float
total_test_functions int
total_production_files int

_SymbolCovmuse/cli/commands/semantic_test_coverage.py

Coverage record for a single production symbol.

Bases: TypedDict

Field Type Required Default
address str
name str
kind str
covered bool
test_functions list[str]

_CommitEntryJsonmuse/cli/commands/shortlog.py

Per-commit entry inside a shortlog group.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | message | str | ✓ | | | committed_at | str | ✓ | | | author | str | None | ✓ | | | agent_id | str | None | ✓ | | | model_id | str | None | ✓ | |

_GroupJsonmuse/cli/commands/shortlog.py

One group (author / agent / model / branch) in the shortlog JSON.

Bases: TypedDict

Field Type Required Default
key str
count int
commits list[_CommitEntryJson]

_ShortlogJsonmuse/cli/commands/shortlog.py

Top-level JSON output for muse shortlog --json.

Bases: TypedDict

Field Type Required Default
repo_id str
branch str
groups list[_GroupJson]

_SnapshotCreateJsonmuse/cli/commands/snapshot_cmd.py

JSON output for muse snapshot create --json.

Bases: TypedDict

Field Type Required Default
repo_id str
snapshot_id str
file_count int
note str
created_at str

_SnapshotExportJsonmuse/cli/commands/snapshot_cmd.py

JSON output for muse snapshot export --json.

Bases: TypedDict

Field Type Required Default
snapshot_id str
output str
format str
file_count int
size_bytes int

_SnapshotListItemJsonmuse/cli/commands/snapshot_cmd.py

One entry in the muse snapshot list --json array.

Bases: TypedDict

Field Type Required Default
snapshot_id str
file_count int
note str
created_at str

_SnapshotShowJsonmuse/cli/commands/snapshot_cmd.py

JSON output for muse snapshot show --json.

Bases: TypedDict

Field Type Required Default
snapshot_id str
created_at str
file_count int
note str
manifest Manifest

ShelfEntrymuse/cli/commands/shelf.py

A single entry on the shelf.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | snapshot_id | str | ✓ | | | delta | Manifest | ✓ | | | deleted | list[str] | ✓ | | | branch | str | ✓ | | | created_at | str | ✓ | | | message | str | None | ✓ | |

_BranchOnlyJsonmuse/cli/commands/status.py

JSON payload for --branch-only output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | branch | str | ✓ | | | head_commit | str | None | ✓ | | | upstream | str | None | ✓ | | | ahead | int | None | ✓ | | | behind | int | None | ✓ | | | merge_in_progress | bool | ✓ | | | merge_from | str | None | ✓ | | | conflict_count | int | ✓ | |

_StagedStatusJsonmuse/cli/commands/status.py

JSON payload for staged-status (code-domain) output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | branch | str | ✓ | | | head_commit | str | None | ✓ | | | clean | bool | ✓ | | | dirty | bool | ✓ | | | staged | _StageEntryMap | ✓ | | | unstaged | Manifest | ✓ | | | untracked | list[str] | ✓ | | | conflict_paths | list[str] | ✓ | | | merge_in_progress | bool | ✓ | | | merge_from | str | None | ✓ | | | conflict_count | int | ✓ | | | checkout_interrupted | bool | ✓ | | | checkout_target | str | None | ✓ | |

_StatusJsonmuse/cli/commands/status.py

JSON payload for full muse status --json output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | branch | str | ✓ | | | head_commit | str | None | ✓ | | | upstream | str | None | ✓ | | | clean | bool | ✓ | | | dirty | bool | ✓ | | | ahead | int | None | ✓ | | | behind | int | None | ✓ | | | total_changes | int | ✓ | | | added | list[str] | ✓ | | | modified | list[str] | ✓ | | | deleted | list[str] | ✓ | | | renamed | Manifest | ✓ | | | conflict_paths | list[str] | ✓ | | | merge_in_progress | bool | ✓ | | | merge_from | str | None | ✓ | | | conflict_count | int | ✓ | | | checkout_interrupted | bool | ✓ | | | checkout_target | str | None | ✓ | |

_UpstreamInfomuse/cli/commands/status.py

Computed ahead/behind counts for the current branch vs its upstream.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | tracking_ref | str | ✓ | | | ahead | int | None | ✓ | | | behind | int | None | ✓ | | | line | str | ✓ | |

_TagJsonmuse/cli/commands/tag.py

Stable JSON schema for a single tag entry (list output).

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | tag_id | str | ✓ | | | commit_id | str | ✓ | | | tag | str | ✓ | | | namespace | str | None | ✓ | | | created_at | str | ✓ | |

_CiGateJsonmuse/cli/commands/test_cmd.py

JSON representation of a single CI gate result.

Bases: TypedDict

Field Type Required Default
name str
command list[str]
exit_code int
duration_ms float
required bool
passed bool
timed_out bool
stdout str
stderr str
warning NotRequired[str]

_CiJsonmuse/cli/commands/test_cmd.py

JSON representation of a full CI run.

Bases: TypedDict

Field Type Required Default
passed bool
timestamp str
total_duration_ms float
gates list[_CiGateJson]

_FullJsonmuse/cli/commands/test_cmd.py

Top-level JSON output for muse code test.

Bases: TypedDict

Field Type Required Default
mode str
selection NotRequired[_SelectionJson]
run NotRequired[_RunJson]
results NotRequired[list[_TestResultJson]]
history NotRequired[list[_HistoryJson]]
ci NotRequired[_CiJson]
error NotRequired[str]

_HistoryJsonmuse/cli/commands/test_cmd.py

JSON representation of a HistorySummary.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | node_id | str | ✓ | | | total_runs | int | ✓ | | | pass_count | int | ✓ | | | fail_count | int | ✓ | | | skip_count | int | ✓ | | | flaky | bool | ✓ | | | avg_duration_ms | float | ✓ | | | last_outcome | str | None | ✓ | | | last_run_timestamp | str | None | ✓ | | | fail_streak | int | ✓ | |

_RunJsonmuse/cli/commands/test_cmd.py

JSON representation of the test execution phase.

Bases: TypedDict

Field Type Required Default
run_id str
exit_code int
duration_ms float
total int
passed int
failed int
errored int
skipped int
timed_out bool
json_report_available bool

_SelectionJsonmuse/cli/commands/test_cmd.py

JSON representation of the test-selection phase.

Bases: TypedDict

Field Type Required Default
changed_addresses list[str]
covered_addresses list[str]
uncovered_addresses list[str]
coverage_fraction float
fallback_used bool
targets list[str]

_TestResultJsonmuse/cli/commands/test_cmd.py

Per-test result in JSON output.

Bases: TypedDict

Field Type Required Default
node_id str
outcome str
duration_ms float
longrepr NotRequired[str]

_ModuleOutmuse/cli/commands/velocity.py

Bases: TypedDict

Field Type Required Default
module str
current _CounterMap
prior _CounterMap
acceleration int
stagnant_commits int

_PredictionOutmuse/cli/commands/velocity.py

Bases: TypedDict

Field Type Required Default
address str
module str
score float
frequency int
last_commit_rank int

_VerifyJsonmuse/cli/commands/verify.py

JSON wire format for muse verify --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | repo_id | str | ✓ | | | refs_checked | int | ✓ | | | commits_checked | int | ✓ | | | snapshots_checked | int | ✓ | | | objects_checked | int | ✓ | | | signatures_checked | int | ✓ | | | all_ok | bool | ✓ | | | check_objects | bool | ✓ | | | branch | str | None | ✓ | | | fail_fast | bool | ✓ | | | failures | list[VerifyFailure] | ✓ | |

_WorkspaceAddJsonmuse/cli/commands/workspace.py

Bases: TypedDict

Field Type Required Default
name str
url str
path str
branch str

_WorkspaceMemberJsonmuse/cli/commands/workspace.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | url | str | ✓ | | | path | str | ✓ | | | branch | str | ✓ | | | present | bool | ✓ | | | head_commit | str | None | ✓ | | | dirty | bool | ✓ | | | actual_branch | str | None | ✓ | | | shelf_count | int | ✓ | | | feature_branches | list[str] | ✓ | |

_WorkspaceRemoveJsonmuse/cli/commands/workspace.py

Bases: TypedDict

Field Type Required Default
name str
removed bool

_WorkspaceSyncJsonmuse/cli/commands/workspace.py

Bases: TypedDict

Field Type Required Default
dry_run bool
workers int
results list[_WorkspaceSyncResultJson]
total int
ok_count int
error_count int

_WorkspaceSyncResultJsonmuse/cli/commands/workspace.py

Bases: TypedDict

Field Type Required Default
name str
status str
ok bool

_WorkspaceUpdateJsonmuse/cli/commands/workspace.py

Bases: TypedDict

Field Type Required Default
name str
url str
path str
branch str

_WorktreeAddJsonmuse/cli/commands/worktree.py

JSON output of muse worktree add --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | |

_WorktreeListEntryJsonmuse/cli/commands/worktree.py

One entry in the JSON array from muse worktree list --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | | | is_main | bool | ✓ | |

_WorktreePruneJsonmuse/cli/commands/worktree.py

JSON output of muse worktree prune --json.

Bases: TypedDict

Field Type Required Default
pruned list[str]
count int
dry_run bool

_WorktreeRemoveJsonmuse/cli/commands/worktree.py

JSON output of muse worktree remove --json.

Bases: TypedDict

Field Type Required Default
name str
status str

HubConfigmuse/cli/config.py

[hub] section in .muse/config.toml.

Bases: TypedDict

Field Type Required Default
url str

LimitsConfigmuse/cli/config.py

[limits] section in .muse/config.toml.

Bases: TypedDict

Field Type Required Default
max_walk_commits int
max_ancestors int
max_graph_commits int
shard_prefix_length int

MuseConfigmuse/cli/config.py

Structured view of the entire .muse/config.toml file.

Bases: TypedDict

Field Type Required Default
user UserConfig
hub HubConfig
remotes RemotesMap
domain DomainConfig
limits LimitsConfig

RemoteConfigmuse/cli/config.py

Public-facing remote descriptor returned by :func:list_remotes.

Bases: TypedDict

Field Type Required Default
name str
url str

RemoteEntrymuse/cli/config.py

[remotes.<name>] section in .muse/config.toml.

Bases: TypedDict

Field Type Required Default
url str
branch str

UserConfigmuse/cli/config.py

[user] section in .muse/config.toml.

Bases: TypedDict

Field Type Required Default
name str
email str
type str

AttributesMetamuse/core/attributes.py

Typed representation of the [meta] section in .museattributes.

Bases: TypedDict

Field Type Required Default
domain str

AttributesRuleDictmuse/core/attributes.py

Typed representation of a single [[rules]] entry.

Bases: TypedDict

Field Type Required Default
path str
dimension str
strategy str
comment str
priority int

MuseAttributesFilemuse/core/attributes.py

Typed representation of the complete .museattributes file.

Bases: TypedDict

Field Type Required Default
meta AttributesMeta
rules list[AttributesRuleDict]

BisectStateDictmuse/core/bisect.py

On-disk shape of the bisect state.

Bases: TypedDict

Field Type Required Default
bad_id str
good_ids list[str]
skipped_ids list[str]
remaining list[str]
log list[str]
branch str
symbol_filter str

CiConfigmuse/core/ci.py

Parsed .muse/ci.toml configuration.

Bases: TypedDict

Field Type Required Default
version int
settings CiSettings
gates list[CiGate]

CiGatemuse/core/ci.py

A single CI gate (one external command).

Bases: TypedDict

Field Type Required Default
name str
command list[str]
timeout_s float
required bool

CiRunResultmuse/core/ci.py

Aggregated result of a full CI run.

Bases: TypedDict

Field Type Required Default
passed bool
gates list[GateResult]
total_duration_ms float
timestamp str

CiSettingsmuse/core/ci.py

Global settings section of .muse/ci.toml.

Bases: TypedDict

Field Type Required Default
test_budget_s float
workers int
env_allowlist list[str]

GateResultmuse/core/ci.py

Outcome for a single CI gate.

Bases: TypedDict

Field Type Required Default
name str
command list[str]
exit_code int
duration_ms float
stdout str
stderr str
required bool
passed bool
timed_out bool
warning NotRequired[str]

_HeartbeatDictmuse/core/coordination.py

JSON-serialisable form of a :class:Heartbeat.

Bases: TypedDict

Field Type Required Default
schema_version str
reservation_id str
run_id str
last_beat_at str
agent_id str

_ReleaseDictmuse/core/coordination.py

JSON-serialisable form of a :class:Release.

Bases: TypedDict

Field Type Required Default
schema_version str
reservation_id str
run_id str
released_at str
reason str

AWMapDictmuse/core/crdts/aw_map.py

Wire format for a complete :class:AWMap.

Bases: TypedDict

Field Type Required Default
entries list[AWMapEntry]
tombstones list[str]

AWMapEntrymuse/core/crdts/aw_map.py

A single (key, value, token) triple in an :class:AWMap.

Bases: TypedDict

Field Type Required Default
key str
value str
token str

GCounterDictmuse/core/crdts/g_counter.py

Wire format for a :class:GCounter{agent_id: count}.

Bases: TypedDict

No annotated fields.

LWWValuemuse/core/crdts/lww_register.py

Wire format for a :class:LWWRegister.

Bases: TypedDict

Field Type Required Default
value str
timestamp float
author str

ORSetDictmuse/core/crdts/or_set.py

Wire format for a complete :class:ORSet.

Bases: TypedDict

Field Type Required Default
entries list[ORSetEntry]
tombstones list[str]

ORSetEntrymuse/core/crdts/or_set.py

A single (element, token) pair in the OR-Set payload.

Bases: TypedDict

Field Type Required Default
element str
token str

RGAElementmuse/core/crdts/rga.py

A single element in an :class:RGA.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | id | str | ✓ | | | value | str | ✓ | | | deleted | bool | ✓ | | | parent_id | str | None | ✓ | |

VClockDictmuse/core/crdts/vclock.py

Wire format for a vector clock — {agent_id: event_count}.

Bases: TypedDict

No annotated fields.

DescribeResultmuse/core/describe.py

Result of describing a commit by its nearest tag.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | tag | str | None | ✓ | | | distance | int | ✓ | | | short_sha | str | ✓ | | | name | str | ✓ | | | exact | bool | ✓ | |

MapInputmuse/core/diff_algorithms/__init__.py

Key → content-ID map. Pairs with MapSchema.

Bases: TypedDict

Field Type Required Default
kind Literal['map']
entries Manifest

SequenceInputmuse/core/diff_algorithms/__init__.py

Ordered sequence of content IDs. Pairs with SequenceSchema.

Bases: TypedDict

Field Type Required Default
kind Literal['sequence']
items list[str]

SetInputmuse/core/diff_algorithms/__init__.py

Unordered set of content IDs. Pairs with SetSchema.

Bases: TypedDict

Field Type Required Default
kind Literal['set']
items frozenset[str]

TensorInputmuse/core/diff_algorithms/__init__.py

Flat 1-D numerical array. Pairs with TensorSchema.

Bases: TypedDict

Field Type Required Default
kind Literal['tensor']
values list[float]

TreeInputmuse/core/diff_algorithms/__init__.py

Labeled ordered tree. Pairs with TreeSchema.

Bases: TypedDict

Field Type Required Default
kind Literal['tree']
root TreeNode

DocReportmuse/core/doc_extractor.py

Complete documentation report for a set of symbols.

Bases: TypedDict

Field Type Required Default
commit_id str
generated_at str
symbols list[SymbolDoc]
missing list[MissingDocEntry]
stale list[StaleDocEntry]
summary DocSummary

DocSummarymuse/core/doc_extractor.py

Aggregate documentation health metrics for a :class:DocReport.

Bases: TypedDict

Field Type Required Default
total_symbols int
public_symbols int
documented int
undocumented int
stale_count int
avg_health float
doc_debt_score float

MissingDocEntrymuse/core/doc_extractor.py

Summary entry for a public symbol that lacks a docstring.

Bases: TypedDict

Field Type Required Default
address str
name str
kind SymbolKind
file str
caller_count int

StaleDocEntrymuse/core/doc_extractor.py

Summary entry for a symbol whose docstring may be out of date.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | address | str | ✓ | | | name | str | ✓ | | | kind | SymbolKind | ✓ | | | file | str | ✓ | | | last_doc_commit | str | None | ✓ | | | last_impl_commit | str | None | ✓ | | | signature_changed | bool | ✓ | | | body_changed | bool | ✓ | |

SymbolDocmuse/core/doc_extractor.py

Fully-assembled documentation record for one symbol.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | address | str | ✓ | | | name | str | ✓ | | | qualified_name | str | ✓ | | | kind | SymbolKind | ✓ | | | file | str | ✓ | | | lineno | int | ✓ | | | end_lineno | int | ✓ | | | signature | str | ✓ | | | docstring | str | None | ✓ | | | callers | list[str] | ✓ | | | callees | list[str] | ✓ | | | since_commit | str | None | ✓ | | | since_version | str | None | ✓ | | | last_changed_commit | str | None | ✓ | | | last_changed_version | str | None | ✓ | | | breaking_changes | list[str] | ✓ | | | linked_tests | list[str] | ✓ | | | doc_health | float | ✓ | | | doc_health_reasons | list[DocHealthReason] | ✓ | |

ChangelogEntrymuse/core/doc_history.py

One symbol's entry in a documentation changelog.

Bases: TypedDict

Field Type Required Default
address str
name str
kind SymbolKind
file str

ChangelogReportmuse/core/doc_history.py

Structured changelog between two commits or version tags.

Bases: TypedDict

Field Type Required Default
from_ref str
to_ref str
added list[ChangelogEntry]
removed list[ChangelogEntry]
changed list[ChangelogEntry]
breaking list[ChangelogEntry]

StaleInfomuse/core/doc_history.py

Docstring staleness assessment for one symbol.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | is_stale | bool | ✓ | | | last_doc_commit | str | None | ✓ | | | last_impl_commit | str | None | ✓ | | | signature_changed | bool | ✓ | | | body_changed | bool | ✓ | |

SymbolVersionEventmuse/core/doc_history.py

One entry in a symbol's version history timeline.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | committed_at | str | ✓ | | | op | str | ✓ | | | version | str | None | ✓ | | | sem_ver_bump | str | None | ✓ | | | breaking | bool | ✓ | |

HubTrustRecordmuse/core/hub_trust.py

A single pinned hub entry in ~/.muse/hub_trust.toml.

Bases: TypedDict

Field Type Required Default
hub_url str
fingerprint str
first_seen str
verified_count int

IdentityEntrymuse/core/identity.py

One authenticated identity, keyed by hub hostname in identity.toml.

Bases: TypedDict

Field Type Required Default
type str
handle str
algorithm str
fingerprint str
hd_path str
capabilities list[str]
provisioned_by str

DomainSectionmuse/core/ignore.py

Patterns for one ignore section (global or a named domain).

Bases: TypedDict

Field Type Required Default
patterns list[str]

IndexInfoEntrymuse/core/indices.py

Status information for one local index — returned by :func:index_info.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | status | str | ✓ | | | entries | int | ✓ | | | updated_at | str | None | ✓ | |

_HashOccurrenceDocmuse/core/indices.py

Msgpack document layout for the hash_occurrence index file.

Bases: TypedDict

Field Type Required Default
schema_version str
index str
updated_at str
entries _StringListMap

_SymbolHistoryDocmuse/core/indices.py

Msgpack document layout for the symbol_history index file.

Bases: TypedDict

Field Type Required Default
schema_version str
index str
updated_at str
entries _EntryMap

BaseReportmuse/core/invariants.py

Full invariant check report for one commit, domain-agnostic.

Bases: TypedDict

Field Type Required Default
commit_id str
domain str
violations list[BaseViolation]
rules_checked int
has_errors bool
has_warnings bool

BaseViolationmuse/core/invariants.py

A single invariant violation, domain-agnostic.

Bases: TypedDict

Field Type Required Default
rule_name str
severity InvariantSeverity
address str
description str

MergeStatePayloadmuse/core/merge_engine.py

JSON-serialisable form of an in-progress merge state.

Bases: TypedDict

Field Type Required Default
base_commit str
ours_commit str
theirs_commit str
conflict_paths list[str]
other_branch str

OpEntrymuse/core/op_log.py

A single operation in the append-only op log.

Bases: TypedDict

Field Type Required Default
op_id str
actor_id str
lamport_ts int
parent_op_ids list[str]
domain str
domain_op DomainOp
created_at str
intent_id str
reservation_id str

OpLogCheckpointmuse/core/op_log.py

A snapshot of the op log state at commit time.

Bases: TypedDict

Field Type Required Default
session_id str
snapshot_id str
lamport_ts int
op_count int
created_at str

ApplyResultmuse/core/mpack.py

Counts returned by :func:apply_mpack describing what was written.

Bases: TypedDict

Field Type Required Default
commits_written int
snapshots_written int
objects_written int
objects_skipped int

FetchRequestmuse/core/mpack.py

Body of POST {url}/fetch — negotiates which commits to transfer.

Bases: TypedDict

Field Type Required Default
want list[str]
have list[str]

ObjectsChunkResponsemuse/core/mpack.py

Response from POST {url}/push/objects — one chunk of a chunked push.

Bases: TypedDict

Field Type Required Default
stored int
skipped int

MPackmuse/core/mpack.py

The unit of exchange between the Muse CLI and a remote.

Bases: TypedDict

Field Type Required Default
commits list[CommitDict]
snapshots list[SnapshotDict]
objects list[ObjectPayload]
tags list[WireTag]
branch_heads BranchHeads

PushResultmuse/core/mpack.py

Server response after a push attempt.

Bases: TypedDict

Field Type Required Default
ok bool
message str
branch_heads BranchHeads

RemoteInfomuse/core/mpack.py

Repository metadata returned by GET {url}/refs.

Bases: TypedDict

Field Type Required Default
repo_id str
domain str
branch_heads BranchHeads
default_branch str

WireTagmuse/core/mpack.py

A tag record serialised for wire transfer inside a :class:MPack.

Bases: TypedDict

Field Type Required Default
tag_id str
repo_id str
commit_id str
tag str
created_at str

_ObjectPayloadBasemuse/core/mpack.py

Required fields for every object payload transmitted over MWP.

Bases: TypedDict

Field Type Required Default
object_id str
content bytes

_WalkResultmuse/core/mpack.py

Cached result of a BFS commit-graph walk.

Bases: TypedDict

Field Type Required Default
commits list[CommitRecord]
snapshot_ids set[str]
all_object_ids list[str]
oid_to_path dict[str, str]
missing_snapshots set[str]

AgentIdentitymuse/core/provenance.py

Structured identity record for a human or AI agent.

Bases: TypedDict

Field Type Required Default
agent_id str
model_id str
toolchain_id str
prompt_hash str
execution_context_hash str

QueryMatchmuse/core/query_engine.py

One match returned by a predicate evaluator.

Bases: TypedDict

Field Type Required Default
commit_id str
author str
committed_at str
branch str
detail str
extra Manifest
agent_id str
model_id str

RebaseProgressmuse/core/rebase.py

Snapshot of rebase progress for --status output.

Bases: TypedDict

Field Type Required Default
active bool
original_branch str
original_head str
onto str
total int
done int
remaining int
squash bool

RebaseStatemuse/core/rebase.py

Serialisable state for an in-progress rebase session.

Bases: TypedDict

Field Type Required Default
original_branch str
original_head str
onto str
remaining list[str]
completed list[str]
squash bool

CRDTDimensionSpecmuse/core/schema.py

Schema for a single dimension that uses CRDT convergent merge semantics.

Bases: TypedDict

Field Type Required Default
name str
description str
crdt_type CRDTPrimitive
independent_merge bool

DimensionSpecmuse/core/schema.py

A named semantic sub-dimension of the domain's state.

Bases: TypedDict

Field Type Required Default
name str
description str
schema ElementSchema
independent_merge bool

DomainSchemamuse/core/schema.py

Complete structural declaration for a domain plugin.

Bases: TypedDict

Field Type Required Default
domain str
description str
dimensions list[DimensionSpec]
top_level ElementSchema
merge_mode Literal['three_way', 'crdt']
schema_version str

MapSchemamuse/core/schema.py

Key-value map with known or dynamic keys.

Bases: TypedDict

Field Type Required Default
kind Literal['map']
key_type str
value_schema ElementSchema
identity Literal['by_key']

SequenceSchemamuse/core/schema.py

Ordered sequence of homogeneous elements (LCS-diffable).

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | kind | Literal['sequence'] | ✓ | | | element_type | str | ✓ | | | identity | Literal['by_id', 'by_position', 'by_content'] | ✓ | | | diff_algorithm | Literal['lcs', 'myers', 'patience'] | ✓ | | | alphabet | list[str] | None | ✓ | |

SetSchemamuse/core/schema.py

Unordered collection of unique elements (set-algebra-diffable).

Bases: TypedDict

Field Type Required Default
kind Literal['set']
element_type str
identity Literal['by_content', 'by_id']

TensorSchemamuse/core/schema.py

N-dimensional numerical array (sparse-numerical-diffable).

Bases: TypedDict

Field Type Required Default
kind Literal['tensor']
dtype Literal['float32', 'float64', 'int8', 'int16', 'int32', 'int64']
rank int
epsilon float
diff_mode Literal['sparse', 'block', 'full']

TreeSchemamuse/core/schema.py

Hierarchical labeled ordered tree (tree-edit-diffable).

Bases: TypedDict

Field Type Required Default
kind Literal['tree']
node_type str
diff_algorithm Literal['zhang_shasha', 'gumtree']

ApiChangeSummarymuse/core/semver.py

A single public-API symbol that was added, removed, or modified.

Bases: TypedDict

Field Type Required Default
address str
language str
kind str
change str

ChangelogEntrymuse/core/semver.py

One commit's contribution to a release changelog.

Bases: TypedDict

Field Type Required Default
commit_id str
message str
sem_ver_bump SemVerBump
breaking_changes list[str]
author str
committed_at str
agent_id str
model_id str

FileHotspotmuse/core/semver.py

A file and the number of times it was touched across the release's commits.

Bases: TypedDict

Field Type Required Default
file_path str
change_count int
language str

LanguageStatmuse/core/semver.py

File and symbol counts for a single programming language in a snapshot.

Bases: TypedDict

Field Type Required Default
language str
files int
symbols int

RefactorEventSummarymuse/core/semver.py

A single structural refactoring event detected across the release's commits.

Bases: TypedDict

Field Type Required Default
kind str
address str
detail str
commit_id str

SemVerTagmuse/core/semver.py

Parsed semantic version components.

Bases: TypedDict

Field Type Required Default
major int
minor int
patch int
pre str
build str

SemanticReleaseReportmuse/core/semver.py

Semantic analysis of a release, computed at push time from the object store.

Bases: TypedDict

Field Type Required Default
languages list[LanguageStat]
total_files int
semantic_files int
total_symbols int
symbols_by_kind list[SymbolKindCount]
files_changed int
api_added list[ApiChangeSummary]
api_removed list[ApiChangeSummary]
api_modified list[ApiChangeSummary]
file_hotspots list[FileHotspot]
refactor_events list[RefactorEventSummary]
breaking_changes list[str]
human_commits int
agent_commits int
unique_agents list[str]
unique_models list[str]
reviewers list[str]

SymbolKindCountmuse/core/semver.py

Count of symbols of a specific kind in a snapshot.

Bases: TypedDict

Field Type Required Default
kind str
count int

FileCacheEntrymuse/core/stat_cache.py

Persisted metadata for a single workspace file.

Bases: TypedDict

Field Type Required Default
mtime float
size int
ino int
object_hash str
dimensions _DimensionMap

_CacheDocmuse/core/stat_cache.py

On-disk msgpack document shape.

Bases: TypedDict

Field Type Required Default
version int
entries _EntryMap

CommitDictmuse/core/commits.py

JSON-serialisable representation of a CommitRecord.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | branch | str | ✓ | | | snapshot_id | str | ✓ | | | message | str | ✓ | | | committed_at | str | ✓ | | | parent_commit_id | str | None | ✓ | | | parent2_commit_id | str | None | ✓ | | | author | str | ✓ | | | metadata | Metadata | ✓ | | | structured_delta | StructuredDelta | None | ✓ | | | sem_ver_bump | SemVerBump | ✓ | | | breaking_changes | list[str] | ✓ | | | agent_id | str | ✓ | | | model_id | str | ✓ | | | toolchain_id | str | ✓ | | | prompt_hash | str | ✓ | | | signature | str | ✓ | | | signer_public_key | str | ✓ | | | signer_key_id | str | ✓ | | | reviewed_by | list[str] | ✓ | | | test_runs | int | ✓ | |

CommitReadCorruptmuse/core/commits.py

Bases: TypedDict

Field Type Required Default
status str
path str
error str

CommitReadNotFoundmuse/core/commits.py

Bases: TypedDict

Field Type Required Default
status str

CommitReadOkmuse/core/commits.py

Bases: TypedDict

Field Type Required Default
status str
commit CommitRecord

DetachedHeadmuse/core/refs.py

HEAD points directly to a commit (detached HEAD state).

Bases: TypedDict

Field Type Required Default
kind Literal['commit']
commit_id str

ReleaseDictmuse/core/releases.py

JSON-serialisable representation of a ReleaseRecord.

Bases: TypedDict

Field Type Required Default
release_id str
repo_id str
tag str
semver SemVerTag
channel str
commit_id str
snapshot_id str
title str
body str
changelog list[ChangelogEntry]
agent_id str
model_id str
is_draft bool
gpg_signature str
created_at str

SnapshotDictmuse/core/snapshots.py

JSON-serialisable representation of a SnapshotRecord.

Bases: TypedDict

Field Type Required Default
snapshot_id str
manifest Manifest
directories list[str]
created_at str
note str

SnapshotReadCorruptmuse/core/snapshots.py

Bases: TypedDict

Field Type Required Default
status str
path str
error str

SnapshotReadNotFoundmuse/core/snapshots.py

Bases: TypedDict

Field Type Required Default
status str

SnapshotReadOkmuse/core/snapshots.py

Bases: TypedDict

Field Type Required Default
status str
snapshot SnapshotRecord

SymbolicHeadmuse/core/refs.py

HEAD points to a named branch.

Bases: TypedDict

Field Type Required Default
kind Literal['branch']
branch str

TagDictmuse/core/tags.py

JSON-serialisable representation of a TagRecord.

Bases: TypedDict

Field Type Required Default
tag_id str
repo_id str
commit_id str
tag str
created_at str

WalkResultmuse/core/commits.py

Result of a bounded history walk.

Bases: TypedDict

Field Type Required Default
commits list[CommitRecord]
truncated bool
count int

CaseRecordmuse/core/test_history.py

Result of a single test function within a run.

Bases: TypedDict

Field Type Required Default
node_id str
outcome Outcome
duration_ms float
symbol_addresses list[str]
longrepr NotRequired[str]

HistorySummarymuse/core/test_history.py

Per-test-function aggregated history summary.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | node_id | str | ✓ | | | total_runs | int | ✓ | | | pass_count | int | ✓ | | | fail_count | int | ✓ | | | skip_count | int | ✓ | | | flaky | bool | ✓ | | | avg_duration_ms | float | ✓ | | | last_outcome | Outcome | None | ✓ | | | last_run_timestamp | str | None | ✓ | | | fail_streak | int | ✓ | |

RunRecordmuse/core/test_history.py

A single muse code test invocation.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | run_id | str | ✓ | | | timestamp | str | ✓ | | | commit_id | str | None | ✓ | | | branch | str | None | ✓ | | | results | list[CaseRecord] | ✓ | | | total | int | ✓ | | | passed | int | ✓ | | | failed | int | ✓ | | | errored | int | ✓ | | | skipped | int | ✓ | |

_HistoryDocmuse/core/test_history.py

Top-level msgpack document shape for the history file.

Bases: TypedDict

Field Type Required Default
version int
runs list[_RunDoc]

_MutableSummarymuse/core/test_history.py

Temporary accumulator used inside :func:summarize.

Bases: TypedDict

Field Type Required Default
node_id str
outcomes list[Outcome]
durations list[float]
timestamps list[str]

_RunDocmuse/core/test_history.py

Msgpack document shape for a single run record.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | run_id | str | ✓ | | | timestamp | str | ✓ | | | commit_id | str | None | ✓ | | | branch | str | None | ✓ | | | total | int | ✓ | | | passed | int | ✓ | | | failed | int | ✓ | | | errored | int | ✓ | | | skipped | int | ✓ | | | results | list[_TestCaseDoc] | ✓ | |

_TestCaseDocmuse/core/test_history.py

Msgpack document shape for a single test-case result.

Bases: TypedDict

Field Type Required Default
node_id str
outcome str
duration_ms float
symbol_addresses list[str]
longrepr str

CaseResultmuse/core/test_runner.py

Outcome for a single pytest test function.

Bases: TypedDict

Field Type Required Default
node_id str
outcome Outcome
duration_ms float
stdout str
stderr str
longrepr NotRequired[str]

RunConfigmuse/core/test_runner.py

Configuration for a single run_tests invocation.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | targets | list[str] | ✓ | | | workers | int | ✓ | | | timeout_s | float | ✓ | | | extra_args | list[str] | ✓ | | | env_allowlist | list[str] | ✓ | | | cwd | pathlib.Path | None | ✓ | | | stream_output | bool | ✓ | |

RunResultmuse/core/test_runner.py

Structured result of a run_tests call.

Bases: TypedDict

Field Type Required Default
run_id str
targets list[str]
exit_code int
duration_ms float
results list[CaseResult]
total int
passed int
failed int
errored int
skipped int
timed_out bool
json_report_available bool
stdout str
stderr str

_FallbackCountsmuse/core/test_runner.py

Counts parsed from pytest text output when JSON report is unavailable.

Bases: TypedDict

Field Type Required Default
total int
passed int
failed int
errored int
skipped int

_ParsedReportmuse/core/test_runner.py

Parsed content from a pytest JSON report file.

Bases: TypedDict

Field Type Required Default
results list[CaseResult]
total int
passed int
failed int
errored int
skipped int

_PartitionResultmuse/core/test_runner.py

Result from executing one subprocess partition.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | exit_code | int | ✓ | | | duration_ms | float | ✓ | | | timed_out | bool | ✓ | | | report | _ParsedReport | None | ✓ | | | stdout | str | ✓ | | | stderr | str | ✓ | | | fallback_counts | _FallbackCounts | None | ✓ | |

ChangedSymbolmuse/core/test_selection.py

A symbol that changed between two snapshots or in the working tree.

Bases: TypedDict

Field Type Required Default
address str
change_kind Literal['modified', 'added', 'deleted']

SelectionResultmuse/core/test_selection.py

Result of a test-selection pass.

Bases: TypedDict

Field Type Required Default
changed_addresses list[str]
test_targets list[SelectionTarget]
covered_addresses list[str]
uncovered_addresses list[str]
coverage_fraction float
fallback_used bool

SelectionTargetmuse/core/test_selection.py

A single pytest-addressable test target to execute.

Bases: TypedDict

Field Type Required Default
node_id str
file str
reason str
confidence float

ConfirmObjectsResponsemuse/core/transport.py

Response from POST {url}/push/objects/confirm — MWP Phase 3b.

Bases: TypedDict

Field Type Required Default
registered int
skipped int

FilterObjectsResultmuse/core/transport.py

Structured result from MWP Phase 1 (POST /filter-objects).

Bases: TypedDict

Field Type Required Default
missing list[str]
bases dict[str, str]

NegotiateResponsemuse/core/transport.py

Response from POST {url}/negotiate — MWP Phase 5.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | ack | list[str] | ✓ | | | common_base | str | None | ✓ | | | ready | bool | ✓ | |

PresignResponsemuse/core/transport.py

Response from POST {url}/presign — MWP Phase 3.

Bases: TypedDict

Field Type Required Default
presigned Manifest
inline list[str]

_PushPayloadmuse/core/transport.py

Msgpack-encoded body for POST {url}/push.

Bases: TypedDict

Field Type Required Default
mpack MPack
branch str
force bool
local_head str

AnnotationSummarymuse/core/type_analysis.py

Type-annotation state for one callable symbol.

Bases: TypedDict

Field Type Required Default
address str
kind str
return_annotation str
return_is_any bool
params_total int
params_annotated int
params_with_any int
type_score float

AnyBlastNodemuse/core/type_analysis.py

One node in the Any-propagation call graph.

Bases: TypedDict

Field Type Required Default
address str
depth int
any_reason str

MigrationTargetmuse/core/type_analysis.py

A symbol worth typing next, ranked by call-graph ROI.

Bases: TypedDict

Field Type Required Default
address str
caller_count int
type_score float
priority_score float

TypeConflictmuse/core/type_analysis.py

A type-signature mismatch between two snapshots.

Bases: TypedDict

Field Type Required Default
address str
signature_a str
signature_b str
change_kind str

TypeDriftPointmuse/core/type_analysis.py

Type-health snapshot at one commit.

Bases: TypedDict

Field Type Required Default
commit_id str
committed_at str
message str
coverage_fraction float
any_count int
delta_coverage float

TypeHealthReportmuse/core/type_analysis.py

Aggregate type health for a snapshot.

Bases: TypedDict

Field Type Required Default
total_symbols int
fully_typed int
partially_typed int
untyped int
any_count int
coverage_fraction float
symbols list[AnnotationSummary]

VerifyFailuremuse/core/verify.py

A single integrity failure detected during muse verify.

Bases: TypedDict

Field Type Required Default
kind Literal['ref', 'commit', 'snapshot', 'object', 'signature', 'key_missing']
id str
error str

VerifyResultmuse/core/verify.py

Aggregate result of a full repository integrity walk.

Bases: TypedDict

Field Type Required Default
refs_checked int
commits_checked int
snapshots_checked int
objects_checked int
signatures_checked int
all_ok bool
failures list[VerifyFailure]

WorkspaceManifestDictmuse/core/workspace.py

Top-level workspace manifest.

Bases: TypedDict

Field Type Required Default
members list[WorkspaceMemberDict]

WorkspaceMemberDictmuse/core/workspace.py

One entry in the workspace manifest.

Bases: TypedDict

Field Type Required Default
name str
url str
path str
branch str

WorkspaceSyncResultmuse/core/workspace.py

Result of syncing one workspace member.

Bases: TypedDict

Field Type Required Default
name str
status str

WorktreeRecordmuse/core/worktree.py

Persisted metadata for a linked worktree.

Bases: TypedDict

Field Type Required Default
name str
branch str
path str

WorktreeStatusResultmuse/core/worktree.py

Machine-readable status of a single worktree.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | | | present | bool | ✓ | | | is_main | bool | ✓ | |

CRDTSnapshotManifestmuse/domain.py

Extended snapshot manifest for CRDT-mode plugins.

Bases: TypedDict

Field Type Required Default
files Manifest
domain str
vclock VectorClock
crdt_state CRDTState
schema_version str

ConflictDictmuse/domain.py

Serialised form of a :class:ConflictRecord.

Bases: TypedDict

Field Type Required Default
path str
conflict_type str
ours_summary str
theirs_summary str
addresses list[str]

DeleteOpmuse/domain.py

An element was removed from a collection.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | op | Literal['delete'] | ✓ | | | address | DomainAddress | ✓ | | | position | int | None | ✓ | | | content_id | str | ✓ | | | content_summary | str | ✓ | |

RenameOpmuse/domain.py

An entity (directory, file, or symbol) was renamed. address is the new address; from_address is the old address. Rename and content modification are orthogonal: a moved+edited file emits a RenameOp followed by a PatchOp — two distinct events.

Bases: TypedDict

Field Type Required Default
op Literal['rename']
address DomainAddress
from_address DomainAddress

EntityProvenancemuse/domain.py

Causal metadata attached to ops that create or modify tracked entities.

Bases: TypedDict

Field Type Required Default
entity_id str
origin_op_id str
last_modified_op_id str
created_at_commit str
actor_id str

FieldMutationmuse/domain.py

The string-serialised before/after of a single field in a :class:MutateOp.

Bases: TypedDict

Field Type Required Default
old str
new str

InsertOpmuse/domain.py

An element was inserted into a collection.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | op | Literal['insert'] | ✓ | | | address | DomainAddress | ✓ | | | position | int | None | ✓ | | | content_id | str | ✓ | | | content_summary | str | ✓ | |

MoveOpmuse/domain.py

An element was repositioned within an ordered sequence.

Bases: TypedDict

Field Type Required Default
op Literal['move']
address DomainAddress
from_position int
to_position int
content_id str

MutateOpmuse/domain.py

A named entity's specific fields were updated.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | op | Literal['mutate'] | ✓ | | | address | DomainAddress | ✓ | | | entity_id | str | ✓ | | | old_content_id | str | ✓ | | | new_content_id | str | ✓ | | | fields | FieldMutationMap | ✓ | | | old_summary | str | ✓ | | | new_summary | str | ✓ | | | position | int | None | ✓ | |

PatchOpmuse/domain.py

A container element was internally modified.

Bases: TypedDict

Field Type Required Default
op Literal['patch']
address DomainAddress
child_ops list[DomainOp]
child_domain str
child_summary str

ReplaceOpmuse/domain.py

An element's value changed (atomic, leaf-level replacement).

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | op | Literal['replace'] | ✓ | | | address | DomainAddress | ✓ | | | position | int | None | ✓ | | | old_content_id | str | ✓ | | | new_content_id | str | ✓ | | | old_summary | str | ✓ | | | new_summary | str | ✓ | |

SnapshotManifestmuse/domain.py

Content-addressed snapshot of domain state.

Bases: TypedDict

Field Type Required Default
files Manifest
domain str
directories list[str]

StageStatusmuse/domain.py

Three-bucket view of working-tree state when a stage is active.

Bases: TypedDict

Field Type Required Default
staged StageIndex
unstaged Manifest
untracked list[str]

StagedEntrymuse/domain.py

One file's staging record inside the code-domain stage index.

Bases: TypedDict

Field Type Required Default
object_id str
mode Literal['A', 'M', 'D']
staged_at str

StructuredDeltamuse/domain.py

Rich, composable delta between two domain snapshots.

Bases: TypedDict

Field Type Required Default
domain str
ops list[DomainOp]
summary str
sem_ver_bump SemVerBump
breaking_changes list[str]

CodeViolationmuse/plugins/code/_invariants.py

A code invariant violation with precise source location.

Bases: TypedDict

Field Type Required Default
rule_name str
severity InvariantSeverity
address str
description str
file str
symbol str
detail str

_FileDatamuse/plugins/code/_invariants.py

All AST-derived data for one Python file, derived from a single parse.

Bases: TypedDict

Field Type Required Default
raw_module_imports list[str]
from_module list[str]
from_name list[str]
top_level_fns list[str]
top_level_classes list[str]
has_all bool
complexity ComplexityMap

_InvariantCacheDocmuse/plugins/code/_invariants.py

On-disk document shape for the invariant file cache (msgpack).

Bases: TypedDict

Field Type Required Default
version int
entries FileDataMap

_RuleRequiredmuse/plugins/code/_invariants.py

Bases: TypedDict

Field Type Required Default
name str
severity InvariantSeverity
scope Literal['function', 'file', 'repo', 'global']
rule_type str

LangSpecmuse/plugins/code/ast_parser.py

Per-language tree-sitter configuration consumed by :class:TreeSitterAdapter.

Bases: TypedDict

Field Type Required Default
name str
extensions frozenset[str]
module_name str
lang_func str
query_str str
kind_map _KindMap
class_node_types frozenset[str]
class_name_field str
receiver_capture str
async_node_child str

SymbolRecordmuse/plugins/code/ast_parser.py

Content-addressed record for a single named symbol in source code.

Bases: TypedDict

Field Type Required Default
kind SymbolKind
name str
qualified_name str
content_id str
body_hash str
signature_id str
metadata_id str
canonical_key str
lineno int
end_lineno int

CodeManifestmuse/plugins/code/manifest.py

Complete hierarchical manifest for one code snapshot.

Bases: TypedDict

Field Type Required Default
snapshot_id str
manifest_hash str
packages list[PackageManifest]
total_files int
semantic_files int
total_symbols int

FileEntrymuse/plugins/code/manifest.py

Metadata for a single source file.

Bases: TypedDict

Field Type Required Default
path str
content_hash str
ast_hash str
language str
symbol_count int
size_bytes int

ManifestFileDiffmuse/plugins/code/manifest.py

Change record from :func:diff_manifests for one file.

Bases: TypedDict

Field Type Required Default
path str
change str
old_hash str
new_hash str
old_ast_hash str
new_ast_hash str
semantic_change bool

ModuleManifestmuse/plugins/code/manifest.py

Manifest for one source file (module).

Bases: TypedDict

Field Type Required Default
module_path str
content_hash str
ast_hash str
language str
symbol_count int

PackageManifestmuse/plugins/code/manifest.py

Directory-level grouping of modules.

Bases: TypedDict

Field Type Required Default
package str
package_hash str
modules list[ModuleManifest]
total_files int
semantic_files int

StageIndexmuse/plugins/code/stage.py

Full contents of the stage index (msgpack-encoded on disk).

Bases: TypedDict

Field Type Required Default
version int
entries StagedFileMap

StagedEntrymuse/plugins/code/stage.py

One file's staging record.

Bases: TypedDict

Field Type Required Default
object_id str
mode Literal['A', 'M', 'D']
staged_at str

BarDensitymuse/plugins/midi/_analysis.py

Note density for one bar.

Bases: TypedDict

Field Type Required Default
bar int
note_count int
notes_per_beat float

BarTensionmuse/plugins/midi/_analysis.py

Harmonic tension for one bar.

Bases: TypedDict

Field Type Required Default
bar int
tension float
label str

Cadencemuse/plugins/midi/_analysis.py

A detected cadence at a phrase boundary.

Bases: TypedDict

Field Type Required Default
bar int
cadence_type str
from_chord str
to_chord str

ContourAnalysismuse/plugins/midi/_analysis.py

Melodic contour shape and statistics.

Bases: TypedDict

Field Type Required Default
shape str
intervals list[int]
range_semitones int
direction_changes int
avg_interval_size float
highest_pitch str
lowest_pitch str

Motifmuse/plugins/midi/_analysis.py

A recurring melodic interval pattern.

Bases: TypedDict

Field Type Required Default
id int
interval_pattern list[int]
occurrences int
bars list[int]
first_pitch str

RhythmAnalysismuse/plugins/midi/_analysis.py

Summary of rhythmic properties.

Bases: TypedDict

Field Type Required Default
total_notes int
bars int
notes_per_bar_avg float
syncopation_score float
quantization_score float
swing_ratio float
dominant_subdivision str

ScaleMatchmuse/plugins/midi/_analysis.py

Best-fit scale result.

Bases: TypedDict

Field Type Required Default
root str
name str
confidence float
out_of_scale_notes int

TempoEstimatemuse/plugins/midi/_analysis.py

Estimated tempo from note onset spacing.

Bases: TypedDict

Field Type Required Default
estimated_bpm float
ticks_per_beat int
confidence str
method str

VoiceLeadingIssuemuse/plugins/midi/_analysis.py

A detected voice-leading problem.

Bases: TypedDict

Field Type Required Default
bar int
issue_type str
description str

RGANoteEntrymuse/plugins/midi/_crdt_notes.py

One element in the :class:MidiRGA linked list.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | op_id | str | ✓ | | | actor_id | str | ✓ | | | note | NoteKey | ✓ | | | position | NotePosition | ✓ | | | parent_op_id | str | None | ✓ | | | tombstone | bool | ✓ | |

InvariantReportmuse/plugins/midi/_invariants.py

Full invariant check report for one commit.

Bases: TypedDict

Field Type Required Default
commit_id str
violations list[InvariantViolation]
rules_checked int
has_errors bool
has_warnings bool

InvariantViolationmuse/plugins/midi/_invariants.py

A single invariant violation record.

Bases: TypedDict

Field Type Required Default
rule_name str
severity Literal['info', 'warning', 'error']
track str
bar int
description str
addresses list[str]

_InvariantRuleRequiredmuse/plugins/midi/_invariants.py

Bases: TypedDict

Field Type Required Default
name str
severity Literal['info', 'warning', 'error']
scope Literal['track', 'bar', 'voice_pair', 'global']
rule_type str

NoteDictmuse/plugins/midi/_midi_query.py

Serialisable representation of a note for query results.

Bases: TypedDict

Field Type Required Default
pitch int
pitch_class str
velocity int
channel int
beat float
duration_beats float

QueryMatchmuse/plugins/midi/_midi_query.py

A single match returned by :func:run_query.

Bases: TypedDict

Field Type Required Default
commit_id str
commit_short str
commit_message str
author str
agent_id str
committed_at str
track str
bar int
notes list[NoteDict]
chord str
matched_on str

EntityIndexmuse/plugins/midi/entity.py

Complete entity index for one track at one commit.

Bases: TypedDict

Field Type Required Default
track_path str
commit_id str
entities _EntityMap

EntityIndexEntrymuse/plugins/midi/entity.py

One entity's record in the per-track entity index.

Bases: TypedDict

Field Type Required Default
content_id str
origin_commit_id str
voice_id str

_NoteEntityRequiredmuse/plugins/midi/entity.py

Required fields shared with NoteKey.

Bases: TypedDict

Field Type Required Default
pitch int
velocity int
start_tick int
duration_ticks int
channel int

BarChunkmuse/plugins/midi/manifest.py

Descriptor for one bar's worth of note events in a MIDI track.

Bases: TypedDict

Field Type Required Default
bar int
chunk_hash str
note_count int
chord str
pitch_range list[int]

MusicManifestmuse/plugins/midi/manifest.py

Top-level hierarchical manifest for a music snapshot.

Bases: TypedDict

Field Type Required Default
domain Literal['midi']
schema_version str
snapshot_id str
files Manifest
tracks _TrackMap

TrackManifestmuse/plugins/midi/manifest.py

Rich metadata descriptor for one MIDI track at a specific snapshot.

Bases: TypedDict

Field Type Required Default
track_id str
file_path str
content_hash str
bars _BarMap
ticks_per_beat int
note_count int
key_guess str
bar_count int

NoteKeymuse/plugins/midi/midi_diff.py

Fully-specified MIDI note used as the LCS comparison unit.

Bases: TypedDict

Field Type Required Default
pitch int
velocity int
start_tick int
duration_ticks int
channel int

_ArchiveJsontests/test_cmd_archive_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | path | str | ✓ | | | format | str | ✓ | | | file_count | int | ✓ | | | bytes | int | ✓ | | | commit_id | str | ✓ | | | message | str | ✓ | | | branch | str | ✓ | | | ref | str | None | ✓ | |

_ChallengeResptests/test_cmd_auth_keygen_register.py

Bases: TypedDict

Field Type Required Default
challengeToken str
isNewKey bool
algorithm str

_VerifyResptests/test_cmd_auth_keygen_register.py

Bases: TypedDict

Field Type Required Default
token str
handle str
identityId str
isNewIdentity bool
authMethod str

_LogJsontests/test_cmd_bisect_hardening.py

Bases: TypedDict

Field Type Required Default
active bool
entries list[str]

_ResetJsontests/test_cmd_bisect_hardening.py

Bases: TypedDict

Field Type Required Default
reset bool

_RunDoneJsontests/test_cmd_bisect_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | done | bool | ✓ | | | first_bad | str | None | ✓ | | | steps_taken | int | ✓ | |

_RunStepJsontests/test_cmd_bisect_hardening.py

Bases: TypedDict

Field Type Required Default
step int
testing str
verdict str
remaining_count int
done bool

_StepJsontests/test_cmd_bisect_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | done | bool | ✓ | | | first_bad | str | None | ✓ | | | next_to_test | str | None | ✓ | | | remaining_count | int | ✓ | | | steps_remaining | int | ✓ | | | verdict | str | ✓ | | | symbol_changes | list[str] | ✓ | |

_BreakageJsontests/test_cmd_breakage.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | schema_version | str | ✓ | | | commit | str | ✓ | | | branch | str | ✓ | | | language_filter | str | None | ✓ | | | path_filter | str | None | ✓ | | | strict | bool | ✓ | | | file_count | int | ✓ | | | issues | list[_BreakageIssue] | ✓ | | | total | int | ✓ | | | errors | int | ✓ | | | warnings | int | ✓ | |

_CreateOuttests/test_cmd_bundle_hardening.py

Bases: TypedDict

Field Type Required Default
file str
commits int
objects int
size_bytes int
branches list[str]

_UnbundleOuttests/test_cmd_bundle_hardening.py

Bases: TypedDict

Field Type Required Default
commits_written int
snapshots_written int
objects_written int
objects_skipped int
refs_updated list[str]

_VerifyOuttests/test_cmd_bundle_hardening.py

Bases: TypedDict

Field Type Required Default
objects_checked int
snapshots_checked int
all_ok bool
failures list[str]

_CheckoutPayloadtests/test_cmd_checkout_symbol.py

Bases: TypedDict

Field Type Required Default
schema_version str
address str
file str
branch str
restored_from str
dry_run bool
changed bool
appended bool
current_start int
current_end int
historical_line_count int
diff_lines list[str]
verified bool
verified_preview bool

_CleanOuttests/test_cmd_clean_hardening.py

Bases: TypedDict

Field Type Required Default
status str
removed list[str]
dirs_removed list[str]
count int
dry_run bool

_ClonesPayloadtests/test_cmd_clones.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | schema_version | str | ✓ | | | commit | str | ✓ | | | branch | str | ✓ | | | tier | str | ✓ | | | min_cluster | int | ✓ | | | kind_filter | str | None | ✓ | | | language_filter | str | None | ✓ | | | file_filter | str | None | ✓ | | | exclude_same_file | bool | ✓ | | | exact_clone_clusters | int | ✓ | | | near_clone_clusters | int | ✓ | | | total_symbols_involved | int | ✓ | | | file_hotspots | list[_HotspotEntry] | ✓ | | | clusters | list[_ClusterEntry] | ✓ | |

_ClusterEntrytests/test_cmd_clones.py

Bases: TypedDict

Field Type Required Default
tier str
hash str
count int
members list[_MemberEntry]

_HotspotEntrytests/test_cmd_clones.py

Bases: TypedDict

Field Type Required Default
file str
clone_symbols int

_MemberEntrytests/test_cmd_clones.py

Bases: TypedDict

Field Type Required Default
address str
kind str
language str
body_hash str
signature_id str
content_id str

_BoundaryEntrytests/test_cmd_codemap.py

Bases: TypedDict

Field Type Required Default
file str
fan_out int
fan_in int

_CentralityEntrytests/test_cmd_codemap.py

Bases: TypedDict

Field Type Required Default
name str
callers int

_CodemapPayloadtests/test_cmd_codemap.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | schema_version | str | ✓ | | | commit | str | ✓ | | | branch | str | ✓ | | | language_filter | str | None | ✓ | | | modules | list[_ModuleEntry] | ✓ | | | import_cycles | list[list[str]] | ✓ | | | high_centrality | list[_CentralityEntry] | ✓ | | | boundary_files | list[_BoundaryEntry] | ✓ | | | agent_safe_zones | list[str] | ✓ | |

_ModuleEntrytests/test_cmd_codemap.py

Bases: TypedDict

Field Type Required Default
file str
symbol_count int
importers int
imports int

_GrepMatchOuttests/test_cmd_content_grep_hardening.py

Bases: TypedDict

Field Type Required Default
line_number int
text str
context_before list[str]
context_after list[str]

_GrepOuttests/test_cmd_content_grep_hardening.py

Bases: TypedDict

Field Type Required Default
commit_id str
snapshot_id str
pattern str
total_files_matched int
total_matches int
results list[_GrepResultOut]

_GrepResultOuttests/test_cmd_content_grep_hardening.py

Bases: TypedDict

Field Type Required Default
path str
object_id str
match_count int
matches list[_GrepMatchOut]

_DescribeOuttests/test_cmd_describe_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | tag | str | None | ✓ | | | distance | int | ✓ | | | short_sha | str | ✓ | | | name | str | ✓ | | | exact | bool | ✓ | | | repo_id | str | ✓ | | | branch | str | ✓ | |

_GcJsontests/test_cmd_gc_hardening.py

Bases: TypedDict

Field Type Required Default
collected_count int
collected_bytes int
reachable_count int
elapsed_seconds float
grace_period_seconds int
dry_run bool
collected_ids list[str]

_PurgePayloadtests/test_cmd_index.py

Bases: TypedDict

Field Type Required Default
schema_version str
purged list[str]
skipped list[str]

_RebuildPayloadtests/test_cmd_index.py

Bases: TypedDict

Field Type Required Default
schema_version str
dry_run bool
rebuilt list[str]
symbol_history_addresses int
symbol_history_events int
hash_occurrence_clusters int
hash_occurrence_addresses int

_StatusEntrytests/test_cmd_index.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | status | str | ✓ | | | entries | int | ✓ | | | updated_at | str | None | ✓ | |

_InvariantsCliJsontests/test_cmd_invariants.py

Shape of the JSON output from muse code invariants --json.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | commit_id | str | ✓ | | | domain | str | ✓ | | | branch | str | ✓ | | | ref | str | ✓ | | | using_defaults | bool | ✓ | | | rule_filter | str | None | ✓ | | | strict | bool | ✓ | | | rules_checked | int | ✓ | | | violations_total | int | ✓ | | | errors | int | ✓ | | | warnings | int | ✓ | | | violations | list[BaseViolation] | ✓ | |

_DryRunCommitJsontests/test_cmd_rebase_hardening.py

Bases: TypedDict

Field Type Required Default
commit_id str
message str

_DryRunJsontests/test_cmd_rebase_hardening.py

Bases: TypedDict

Field Type Required Default
branch str
onto str
commits list[_DryRunCommitJson]
count int
squash bool

_ResultJsontests/test_cmd_rebase_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | status | str | ✓ | | | branch | str | ✓ | | | new_head | str | None | ✓ | | | onto | str | ✓ | | | squash | bool | ✓ | | | replayed | int | ✓ | | | conflicts | list[str] | ✓ | |

_StatusJsontests/test_cmd_rebase_hardening.py

Bases: TypedDict

Field Type Required Default
active bool
original_branch str
original_head str
onto str
total int
done int
remaining int
squash bool

_DeleteJsontests/test_cmd_release_hardening.py

Bases: TypedDict

Field Type Required Default
status str
tag str
was_draft bool
remote_retracted bool
dry_run bool

_PushJsontests/test_cmd_release_hardening.py

Bases: TypedDict

Field Type Required Default
status str
tag str
remote str
release_id str
dry_run bool

_ShowJsontests/test_cmd_release_hardening.py

Bases: TypedDict

Field Type Required Default
tag str
channel str
commit_id str
snapshot_id str
release_id str
is_draft bool

_CherryPickPayloadtests/test_cmd_semantic_cherry_pick.py

Bases: TypedDict

Field Type Required Default
schema_version str
branch str
from_commit str
dry_run bool
results list[_ResultEntry]
applied int
already_current int
failed int
unverified list[str]

_ResultEntrytests/test_cmd_semantic_cherry_pick.py

Bases: TypedDict

Field Type Required Default
address str
status str
detail str
old_lines int
new_lines int
diff_lines list[str]
verified bool

_GroupOuttests/test_cmd_shortlog_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | key | str | ✓ | | | count | int | ✓ | | | commits | list[dict[str, str | None]] | ✓ | |

_ShortlogOuttests/test_cmd_shortlog_hardening.py

Bases: TypedDict

Field Type Required Default
repo_id str
branch str
groups list[_GroupOut]

_CreateOuttests/test_cmd_snapshot_hardening.py

Bases: TypedDict

Field Type Required Default
repo_id str
snapshot_id str
file_count int
note str
created_at str

_ExportOuttests/test_cmd_snapshot_hardening.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
output str
format str
file_count int
size_bytes int

_ListItemOuttests/test_cmd_snapshot_hardening.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
file_count int
note str
created_at str

_ShowOuttests/test_cmd_snapshot_hardening.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
created_at str
file_count int
note str
manifest Manifest

_FailureOuttests/test_cmd_verify_hardening.py

Bases: TypedDict

Field Type Required Default
kind str
id str
error str

_VerifyOuttests/test_cmd_verify_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | repo_id | str | ✓ | | | refs_checked | int | ✓ | | | commits_checked | int | ✓ | | | snapshots_checked | int | ✓ | | | objects_checked | int | ✓ | | | signatures_checked | int | ✓ | | | all_ok | bool | ✓ | | | check_objects | bool | ✓ | | | branch | str | None | ✓ | | | fail_fast | bool | ✓ | | | failures | list[_FailureOut] | ✓ | |

_AddJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

Field Type Required Default
name str
url str
path str
branch str

_ListMemberJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | url | str | ✓ | | | path | str | ✓ | | | branch | str | ✓ | | | present | bool | ✓ | | | head_commit | str | None | ✓ | | | dirty | bool | ✓ | | | actual_branch | str | None | ✓ | | | shelf_count | int | ✓ | | | feature_branches | list[str] | ✓ | |

_RemoveJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

Field Type Required Default
name str
removed bool

_SyncJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

Field Type Required Default
dry_run bool
workers int
results list[_SyncResultItemJson]
total int
ok_count int
error_count int

_SyncResultItemJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

Field Type Required Default
name str
status str
ok bool

_UpdateJsontests/test_cmd_workspace_hardening.py

Bases: TypedDict

Field Type Required Default
name str
url str
path str
branch str

_AddJsontests/test_cmd_worktree_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | |

_ListEntryJsontests/test_cmd_worktree_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | | | is_main | bool | ✓ | |

_PruneJsontests/test_cmd_worktree_hardening.py

Bases: TypedDict

Field Type Required Default
pruned list[str]
count int
dry_run bool

_RemoveJsontests/test_cmd_worktree_hardening.py

Bases: TypedDict

Field Type Required Default
name str
status str

_StatusJsontests/test_cmd_worktree_hardening.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | name | str | ✓ | | | branch | str | ✓ | | | path | str | ✓ | | | head_commit | str | None | ✓ | | | present | bool | ✓ | | | is_main | bool | ✓ | |

_LangEntrytests/test_code_commands.py

Bases: TypedDict

Field Type Required Default
language str
files int
symbols int
kinds _KindsMap

_LangsJsontests/test_code_commands.py

Bases: TypedDict

Field Type Required Default
languages list[_LangEntry]

_BundleDicttests/test_integrity_I1_read_verify.py

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | objects | list[dict[str, str | bytes]] | ✓ | | | snapshots | list[_BundleSnapEntry] | ✓ | | | commits | list[dict[str, str]] | ✓ | |

_BundleSnapEntrytests/test_integrity_I1_read_verify.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
manifest Manifest

_CommitJsontests/test_integrity_I7_history_walk.py

Shape of a single commit entry in muse log --json.

Bases: TypedDict

Field Type Required Default
commit_id str
branch str
message str
author str
committed_at str
parent_commit_id str
snapshot_id str
metadata Manifest
sem_ver_bump str

_LogOutputtests/test_integrity_I7_history_walk.py

Shape of muse log --json output.

Bases: TypedDict

Field Type Required Default
truncated bool
commits list[dict[str, str]]

_CommitEntrytests/test_plumbing_verify_pack.py

Bases: TypedDict

Field Type Required Default
commit_id str
snapshot_id str

_ObjectEntrytests/test_plumbing_verify_pack.py

Bases: TypedDict

Field Type Required Default
object_id str
content bytes

_SnapshotEntrytests/test_plumbing_verify_pack.py

Bases: TypedDict

Field Type Required Default
snapshot_id str
manifest Manifest

_CheckRefFormatResulttests/test_security_branch_ref_injection.py

Shape of muse plumbing check-ref-format --json output.

Bases: TypedDict

| Field | Type | Required | Default | |-------|------|:--------:|---------| | all_valid | bool | ✓ | | | valid_count | int | ✓ | | | invalid_count | int | ✓ | | | results | list[dict[str, str | bool | None]] | ✓ | | | max_length | int | ✓ | | | forbidden_chars | list[str] | ✓ | | | forbidden_patterns | list[str] | ✓ | | | notes | str | ✓ | |

MidiKwargstests/test_stress_midi_all_dims.py

Bases: TypedDict

Field Type Required Default
notes list[tuple[int, int, int]]
pitchwheel list[tuple[int, int]]
control_change list[tuple[int, int, int]]
channel_pressure list[tuple[int, int]]
poly_aftertouch list[tuple[int, int, int]]
program_change list[tuple[int, int]]
set_tempo int
time_sig tuple[int, int]
key_sig str
marker str
track_name str
ticks_per_beat int

Protocols

InvariantCheckermuse/core/invariants.py

Protocol every domain invariant checker must satisfy.

Bases: Protocol

No annotated fields.

MuseTransportmuse/core/transport.py

Protocol for Muse remote transport implementations.

Bases: Protocol

No annotated fields.

_HttpHeadersmuse/core/transport.py

Minimal interface for HTTP response headers.

Bases: Protocol

No annotated fields.

_HttpResponsemuse/core/transport.py

Structural interface for urllib HTTP response objects.

Bases: Protocol

Field Type Required Default
headers _HttpHeaders

CRDTPluginmuse/domain.py

Optional extension for plugins that want convergent CRDT merge semantics.

Bases: MuseDomainPlugin, Protocol

No annotated fields.

MuseDomainPluginmuse/domain.py

The six interfaces a domain plugin must implement.

Bases: Protocol

No annotated fields.

StagePluginmuse/domain.py

Optional extension for plugins that support selective commit staging.

Bases: MuseDomainPlugin, Protocol

No annotated fields.

StructuredMergePluginmuse/domain.py

Optional extension for plugins that support operation-level merging.

Bases: MuseDomainPlugin, Protocol

No annotated fields.

FrameworkPluginmuse/plugins/code/_framework.py

Protocol every framework entry-point plugin must satisfy.

Bases: Protocol

No annotated fields.

LanguageAdaptermuse/plugins/code/ast_parser.py

Protocol every language adapter must implement.

Bases: Protocol

No annotated fields.

File History 1 commit