Welcome to CLFits’s documentation!

CLFits is a command-line tool for viewing and editing the headers of FITS files. It provides a simple, scriptable interface for common header operations.

Contents:

• Tutorial
  • Scenario
  • Step 1: View the Primary Header
  • Step 2: Discover and View Extensions
  • Step 3: Search for a Keyword
  • Step 4: Correct the Keyword Value
  • Step 5: Export the Corrected Header
• API Reference
  • delete()
  • export()
  • get()
  • main()
  • search()
  • set()
  • version_callback()
  • view()
  • read_header()
  • write_header()
• Shell Completion
  • Installation
  • Usage

Key Features

• View, Get, Set, and Delete keywords in any FITS header.

• Target Specific HDUs by index or by name.

• Search and Filter headers for keywords matching specific patterns.

• Export headers to common formats like JSON, YAML, and CSV.

• Cross-platform support for Linux, macOS, and Windows.

Indices and tables

• Index

• Module Index

• Search Page