Skip to content

docs(prd): add and revise PRD for atmos version --short flag#2220

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/update-prd-for-atmos-2174
Draft

docs(prd): add and revise PRD for atmos version --short flag#2220
Copilot wants to merge 3 commits intomainfrom
copilot/update-prd-for-atmos-2174

Conversation

Copy link
Contributor

Copilot AI commented Mar 17, 2026

Adds docs/prd/version-short-flag.md documenting the design behind PR #2174, which introduces atmos version --short / -s and --format plain for machine-readable version output.

Changes

  • New PRD: docs/prd/version-short-flag.md covering problem statement, goals, implementation details, affected files, usage, format comparison table, testing strategy, and design decisions
  • Revised: removed em dashes, dropped redundant sections (standalone "Output Channel", "Scripting Examples"), removed irrelevant non-goal, condensed overview, added missing note on --check + --short interaction, attributed blog post to nitrocode

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
Copilot AI changed the title [WIP] Update PRD for atmos pull request 2174 docs(prd): add PRD for atmos version --short flag Mar 17, 2026
Copilot AI requested a review from nitrocode March 17, 2026 17:40
… weaknesses

Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
Copilot AI changed the title docs(prd): add PRD for atmos version --short flag docs(prd): add and revise PRD for atmos version --short flag Mar 17, 2026
@mergify mergify bot added the triage Needs triage label Mar 17, 2026

## Overview

`atmos version --short` (alias `-s`) prints only the bare version number to stdout: no banner, no alien icon, no update check, no OS/arch suffix. `--format plain` is the underlying canonical format; `ATMOS_VERSION_SHORT` is the corresponding environment variable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would this not be --format=short or --format=plain?

atmos version --format --help        

$ atmos version --format json

• Display version in YAML format

$ atmos version --format yaml

• Pipe JSON output to jq

$ atmos version --format json | jq -r .version

• Check for updates and display in JSON

$ atmos version --check --format json

@nitrocode nitrocode added no-release Do not create a new release (wait for additional code changes) and removed triage Needs triage labels Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release Do not create a new release (wait for additional code changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants