docs: Update exampels in README and help cmd

[Fcmam5]

Summary by CodeRabbit

• Documentation

  • Added "Skill input formats" section with examples
  • Updated code examples to use ES module imports
  • Replaced documented validate command with audit (placeholder)

• New Features

  • Command-specific help output (use --help after a command)
  • Short-form flags supported (e.g., -h normalized to help)
  • list command supports --format=table|json

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a4f5113e-908b-4164-9286-117ccc3dc3c1

📥 Commits

Reviewing files that changed from the base of the PR and between ab2cbfd and 080d0ef.

📒 Files selected for processing (1)

• bin/skilleton.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• bin/skilleton.ts

---

📝 Walkthrough

Walkthrough

Adds README "Skill input formats" and updates programmatic example to ES module import; replaces skilleton validate with skilleton audit. CLI parsing now maps short -h to help, supports --flag=value/--flag <value>, and prints command-specific help for add when help is requested, with list help noting --format=table|json. (50 words)

Changes

Cohort / File(s)	Summary
Documentation README.md	Added "Skill input formats" section documenting shorthand (three-segment) and full forms for skill references, clarified root-repo vs monorepo path usage, replaced skilleton validate with skilleton audit, and switched programmatic example from CommonJS require() to ES module import.
CLI / bin bin/skilleton.ts	Mapped short -h to help, ensured --flag=value and --flag <value> parsing supported, extended printHelp(command?) to emit add-specific usage/examples and step-by-step description, intercepts help flag for known commands to print tailored help and exit early, and updated global help text to show list supports `--format=table

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant CLI as CLI Parser
    participant Help as printHelp()
    participant Cmd as Command Handler

    User->>CLI: invoke "skilleton add --help" or "-h"
    CLI->>CLI: normalize flags (-h → help), parse args
    CLI->>Help: help requested for command "add"
    Help-->>User: print add-specific usage, examples
    CLI--xUser: exit (do not run Cmd)

    alt help not requested
        User->>CLI: invoke "skilleton add ..."
        CLI->>Cmd: run add handler with parsed args
        Cmd-->>User: command output
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I nibbled docs and hopped through code,
Short flags now dance along the road,
Imports bright as morning dew,
Help for "add" shows steps anew,
A little rabbit, proud and owed.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title mentions updating 'exampels' and 'help cmd', but the changes include more substantial updates: new 'Skill input formats' documentation section, CLI command replacement (validate→audit), and ES module imports—not just example corrections.	Revise the title to reflect the primary changes, such as 'docs: Add skill input formats documentation and update CLI examples' or 'docs: Restructure documentation with new skill formats section and help command updates'.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/update-help-and-examples

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@bin/skilleton.ts`:
- Around line 79-80: The help flag check (if (args.flags.help || args.flags.h)
in bin/skilleton.ts) never sees -h because parseArgs currently only parses long
(--help) flags; update parseArgs to recognize short flags (e.g., map -h to
flags.h) or add a quick check that treats a single positional "-h" as help
before command execution. Locate the parseArgs implementation and ensure it
converts "-h" into args.flags.h (or sets args.flags.help), or modify the caller
to inspect args.positional for "-h" and call printHelp(command) if found,
keeping the existing printHelp usage intact.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7bb3f2da-4758-478c-9239-62bead2d924d

📥 Commits

Reviewing files that changed from the base of the PR and between d3a2bef and b85d446.

📒 Files selected for processing (2)

• README.md
• bin/skilleton.ts

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@bin/skilleton.ts`:
- Around line 83-87: The help check currently short-circuits before validating
the requested command (args.flags.help -> printHelp(command)), letting invalid
commands like "nope --help" succeed; change control flow so command
validation/unknown-command handling runs before honoring --help: call the
existing unknown-command validation logic (the code that verifies "command" and
emits the error) first, and only if the command is known then call
printHelp(command) when args.flags.help is true; alternatively, check
args.command/command validity at the top and return an error before printing
help, ensuring the process exits with an error status for unknown commands.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e26776da-7f59-4075-8a7f-4335eec5d486

📥 Commits

Reviewing files that changed from the base of the PR and between b85d446 and ab2cbfd.

📒 Files selected for processing (1)

• bin/skilleton.ts