Skip to content

[DOCS] apc --version works but is never mentioned in README or docs #26

@FZ2000

Description

@FZ2000

Problem

The CLI has @click.version_option(version="0.1.0") in main.py, so apc --version works. But this is never mentioned anywhere:

  • Not in the README
  • Not in the Quick Start
  • Not in the Command Reference

This is a small but consistent gap. When developers hit a bug or want to report an issue, they'll reach for apc --version — and they should know it exists.

Suggested Fix

Add to the README's Installation section or Command Reference:

apc --version
# apc, version 0.1.0

Also consider: currently the version is hardcoded as "0.1.0" in main.py and presumably also in pyproject.toml. This means they can drift. Use importlib.metadata to avoid duplication:

from importlib.metadata import version
@click.version_option(version=version("apc-cli"), prog_name="apc")

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions