archledger

archledger stores arc42 architecture knowledge as canonical source fragments and assembles output documents on demand.

User guide

• CLI guide
  • init — Initialize a workspace
  • Other commands
• Configuration
  • Important sections
  • Example
  • ID segment modes
  • Per-output overrides
• Source model
  • Canonical source
  • Ledger ID format
  • Traceability
  • Generated output
• Source tracking
  • Snapshots
  • Changes
  • Linking source_refs
  • Recommended workflow
• Build and export
  • Native builds
  • Converter-backed exports
  • Diagram records
  • Source migration
• Release process
  • Pre-release checks
  • Build and metadata validation
  • Installed-wheel smoke test
  • Converter-backed release confidence
  • Release decision
• Agent workflow
  • Recommended loop
  • Rules

API

• API reference
  • InitResult
  • StatusResult
  • CheckFinding
  • CheckResult
  • ArchiveResult
  • DoctorRepair
  • DoctorResult
  • ArchitectureRepository
  • path_in_archive()
  • known_source_extensions()
  • SectionSpec
  • SourceRef
  • ArchitectureRecord
  • normalize_kind()
  • validate_record()
  • SourceFormatSpec
  • source_format_spec()
  • default_extension_for_source_format()
  • native_output_format_for_source_format()
  • infer_output_format_from_path()
  • default_document_filename_for_output_format()
  • document_template_name_for_source_format()
  • record_template_name_for_source_format()
  • section_body_placeholder_for_source_format()
  • empty_section_placeholder_for_source_format()
  • section_filename_for()
  • filename_for()
  • id_from_filename()
  • is_visible_status()
  • record_sort_key()
  • TrackedFile
  • DirectoryState
  • SourceState
  • ChangedFile
  • PossibleRename
  • ImpactedRecord
  • ChangeSet
  • scan_workspace()
  • diff_source_states()
  • resolve_impacts()
  • Arc42Config
  • BuildConfig
  • BuildOutputConfig
  • DiagramConfig
  • ProjectConfig
  • IdConfig
  • SkillConfig
  • SourceConfig
  • TrackingConfig
  • LedgerIdFormat
  • build_default_project_config()
  • load_project_config()
  • normalize_project_name()
  • render_default_config()
  • render_project_config()