docs: use podman runtime in examples instead of fake

[feloy]

Updates all user-facing documentation to demonstrate the podman runtime instead of the fake runtime, making examples more practical for actual usage.

Fixes #175

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated user-facing documentation across README.md and the init command help text to replace --runtime fake with --runtime podman in all example invocations. No functional logic or command behavior was modified.

Changes

Cohort / File(s)	Summary
Documentation Examples README.md	Replaced instances of --runtime fake with --runtime podman in examples, JSON/verbose/error outputs, shell snippets, and environment-variable usage examples. Displayed output text remained unchanged.
Command Help Text pkg/cmd/init.go	Updated NewInitCmd() Example help text to use --runtime podman instead of --runtime fake across all example scenarios; no code paths, flags, or logic were altered.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• feat: init command #23 — Introduces/implements NewInitCmd; related because it touches the same pkg/cmd/init.go help/examples area.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
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 (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: replacing fake runtime examples with podman runtime in documentation.
Description check	✅ Passed	The description accurately relates to the changeset by explaining the purpose of updating documentation to use podman runtime instead of fake.
Linked Issues check	✅ Passed	The PR fully addresses issue #175 by replacing all --runtime fake references with --runtime podman in both README.md and help text (pkg/cmd/init.go).
Out of Scope Changes check	✅ Passed	All changes are directly related to updating documentation examples to use podman runtime, with no unrelated modifications present.

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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

628-658: ⚠️ Potential issue | 🟠 Major

Remaining fake runtime examples should be updated to podman.

There are still user-facing examples showing fake runtime (Line 635, Line 651, Line 1575), which leaves the docs inconsistent with this PR objective.

Suggested doc fix

-export KORTEX_CLI_DEFAULT_RUNTIME=fake
+export KORTEX_CLI_DEFAULT_RUNTIME=podman
...
-export KORTEX_CLI_DEFAULT_RUNTIME=fake
+export KORTEX_CLI_DEFAULT_RUNTIME=podman
...
-kortex-cli init -r fake -a claude -o json -v
+kortex-cli init -r podman -a claude -o json -v

Also applies to: 1573-1576

🤖 Prompt for AI Agents

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

In `@README.md` around lines 628 - 658, Update the remaining example usages that
still reference the "fake" runtime to use "podman" instead: replace occurrences
of KORTEX_CLI_DEFAULT_RUNTIME=fake and example commands like `kortex-cli init
... --runtime fake` with `podman`, including the usage examples under the
KORTEX_CLI_DEFAULT_RUNTIME section and the other example block around lines
referenced (the examples showing `fake` at the end of the README); ensure both
the environment variable example and the command-line override examples use
`podman` so the docs are consistent with the PR objective.

🤖 Prompt for all review comments with AI agents

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

Inline comments:
In `@README.md`:
- Line 426: Remove the leading shell prompt characters from the inline command
snippets to satisfy markdownlint MD014: replace occurrences of "$ kortex-cli
init /path/to/project --runtime podman --agent claude -o json" and the other
similar lines (the snippets currently prefixed with "$" at the README) with the
bare commands (e.g., "kortex-cli init /path/to/project --runtime podman --agent
claude -o json"), and do the same for the other reported occurrences so each
fenced/indented code block contains only the command text without a "$" prompt.

---

Outside diff comments:
In `@README.md`:
- Around line 628-658: Update the remaining example usages that still reference
the "fake" runtime to use "podman" instead: replace occurrences of
KORTEX_CLI_DEFAULT_RUNTIME=fake and example commands like `kortex-cli init ...
--runtime fake` with `podman`, including the usage examples under the
KORTEX_CLI_DEFAULT_RUNTIME section and the other example block around lines
referenced (the examples showing `fake` at the end of the README); ensure both
the environment variable example and the command-line override examples use
`podman` so the docs are consistent with the PR objective.

🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cb019c33-509d-42a2-8334-5841da7671f3

📥 Commits

Reviewing files that changed from the base of the PR and between 6ec4a85 and 6d9bd48.

📒 Files selected for processing (2)

• README.md
• pkg/cmd/init.go

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

1652-1655: ⚠️ Potential issue | 🟡 Minor

Replace the remaining fake runtime example to fully meet the PR objective.

There is still one user-facing example using -r fake, which conflicts with the podman-only documentation update objective.

Suggested fix

 **JSON output with short flags:**
 ```bash
-kortex-cli init -r fake -a claude -o json -v
+kortex-cli init -r podman -a claude -o json -v

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

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

In @README.md around lines 1652 - 1655, Update the remaining example command
that uses the fake runtime by changing the runtime flag value in the user-facing
example string "kortex-cli init -r fake -a claude -o json -v" to use the podman
runtime; replace "kortex-cli init -r fake -a claude -o json -v" with "kortex-cli
init -r podman -a claude -o json -v" so the README no longer shows the
deprecated fake runtime.

</details>

</blockquote></details>

</blockquote></details>

🤖 Prompt for all review comments with AI agents

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

Outside diff comments:
In `@README.md`:
- Around line 1652-1655: Update the remaining example command that uses the fake
runtime by changing the runtime flag value in the user-facing example string
"kortex-cli init -r fake -a claude -o json -v" to use the podman runtime;
replace "kortex-cli init -r fake -a claude -o json -v" with "kortex-cli init -r
podman -a claude -o json -v" so the README no longer shows the deprecated fake
runtime.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0502cca1-2764-4b00-abc9-460f3941694c

📥 Commits

Reviewing files that changed from the base of the PR and between 6d9bd48 and b600e1a.

📒 Files selected for processing (2)

• README.md
• pkg/cmd/init.go

✅ Files skipped from review due to trivial changes (1)

• pkg/cmd/init.go