Update README for namespace support and renamed commands #68
Conversation
- Add namespace support info to key features - Update get-output-types command with namespace examples - Rename get-output-lookup-tree to get-output-type-details - Update add-input command documentation with namespace format - Add examples for namespace usage throughout - Update register-output-type with namespace examples
WalkthroughThe README.md file was updated to include a new "Key Features" section and expanded documentation for several FTF CLI commands. These updates clarify usage, especially around output types and namespaces, introduce a new command for inspecting output types, and provide improved examples and formatting for better usability. Changes
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
181-187: Minor wording nitpick for--output-typedescriptionThe phrase “Supports both default (@outputs) and custom namespaces.” is clear, but readers might wonder what happens if they omit the namespace. Consider making the default explicit, e.g.:
-Supports both default (@outputs) and custom namespaces. +If no namespace is supplied, the value is assumed to be in the default “@outputs” namespace. Custom namespaces are also supported.
300-315: Add a fenced-code language to silence markdownlint (MD040)
markdownlint-cli2flags the example block because no language is declared.-``` +```text Registered output types: - @custom/sqs - @outputs/cache - @outputs/database -``` +```
329-354: Same MD040 issue for the long “Example Output” blockExplicitly declaring a language (e.g.,
textorjson/yamlif you split it) removes the lint warning and gives nicer syntax highlighting.-``` +```text === Output Type Details: @custom/sqs === ... "out": { "attributes": {"queue_arn": {}, "queue_url": {}}, "interfaces": {} } } -``` +```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
310-310: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
330-330: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (1)
README.md (1)
5-12: New Key Features section looks solidClear, concise bullets that immediately communicate the CLI’s value – nice touch.
| #### Get Output Type Details | ||
|
|
||
| Retrieve comprehensive details for a specific registered output type from the control plane, including properties and lookup tree. | ||
|
|
||
| ```bash | ||
| ftf get-output-lookup-tree [OPTIONS] | ||
| ftf get-output-type-details [OPTIONS] | ||
| ``` |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify CLI implementation for renamed command
Docs introduce ftf get-output-type-details (formerly get-output-lookup-tree). Ensure the actual CLI has been updated so users don’t hit “command not found”.
🏁 Script executed:
#!/bin/bash
# Confirm only the new command exists and the old one is gone.
rg -n "get-output-lookup-tree" || echo "✅ old command not found"
rg -n "get-output-type-details" | headLength of output: 178
Implement and Register the New CLI Command
After verifying:
- ✅
get-output-lookup-treeis no longer in the codebase ⚠️ No occurrences ofget-output-type-detailsoutside of README.md
The CLI implementation for ftf get-output-type-details is missing. Please add and register this command in your CLI code (e.g., create or update cmd/get-output-type-details.go and wire it into your root command) so that the documentation and executable stay in sync.
🤖 Prompt for AI Agents
In README.md around lines 317 to 323, the documentation describes the CLI
command `ftf get-output-type-details`, but this command is not implemented or
registered in the codebase. To fix this, create a new CLI command file (e.g.,
`cmd/get-output-type-details.go`) that implements the command's functionality to
retrieve output type details, then register this command with the root CLI
command so it is executable and consistent with the documentation.
Summary by CodeRabbit
ftf add-input, clarifying--output-typeusage and providing examples.ftf get-output-typesto specify namespace/name display and added example output.ftf get-output-type-detailscommand with examples.ftf register-output-typerequirements and provided example YAML.