Astrona docs

astrona docs¶

Read the lab's docs (task, hints, prerequisites, solution) in the terminal

Synopsis¶

Show a lab's own documentation, rendered for the terminal and paged ($PAGER, else less; --no-pager to print). With no argument, lists what the lab provides.

question the task to solve (question.md, or metadata.docs.question) case-study the same task with more guidance (case-study.md, or metadata.docs.caseStudy) prerequisites what to know before starting (prerequisites.md, or metadata.docs.prerequisites) solution the full step-by-step solution (solution.md, or metadata.docs.solution) — spoilers; guide works too

A doc metadata.docs doesn't list is found by that file name next to config.yaml.

Uses the lab config from -c/--file/--git (local, git or URL), or a catalog lab named as an argument (astrona docs question astrona.io/ATS016/section-020/module-01/lab-01).

astrona docs [question|case-study|prerequisites|solution] [catalog-lab] [flags]

Examples¶

  astrona docs -c ./labs/my-lab
  astrona docs question -c ./labs/my-lab

Options¶

  -h, --help       help for docs
      --no-pager   Print directly instead of using a pager

Options inherited from parent commands¶

      --accept-terms      Accept this CLI's usage terms and data-loss risk notice; required on each operational CI command (read: astrona terms)
  -c, --config string     Path or URL to the lab config directory (with --git: a subdirectory within the cloned repo) (default ".")
  -f, --file string       Configuration file name override (default "config.yaml")
      --git string        Git repository URL to clone/pull (https://, git@host:, or ssh://) — --config then selects a subdirectory within it
      --git-ref string    Git branch, tag, or commit to check out (used with --git; default: the repo's default branch)
      --headless          Disable the terminal UI and CLI prompts; run/reset skip login reminders and new account sessions
      --install-version   If the lab needs another astrona release (astronaVersion) that isn't installed, install it without asking — for CI
      --trust             Approve running a remote (--git / URL) lab without asking — for CI; review the lab first
      --update-check      Check for new CLI releases (disabled in CI, without a terminal, or by ASTRONA_NO_UPDATE_CHECK) (default true)
      --verbose           Stream the full output of every underlying command instead of the compact step view