docs(cli): document directory input and the oasf type in import help - #2032
Draft
AmrendraTheCoder wants to merge 1 commit into
Draft
docs(cli): document directory input and the oasf type in import help#2032AmrendraTheCoder wants to merge 1 commit into
AmrendraTheCoder wants to merge 1 commit into
Conversation
dir-importer gained directory support for the mcp, a2a and oasf import types in agntcy/dir-importer#87, but the import command's help still describes --file-path as a JSON file. Separately, oasf has been a working --type for a while: --type binds to a plain string that is handed to config.ImportType without an allowlist, and dir-importer validates it. It was missing from the kinds list, the --type flag text and the command summary, so there was no way to discover it from the CLI. Documents both, and adds a directory example. Note: this describes behaviour that ships with a dir-importer release containing agntcy/dir-importer#87. That change landed after v1.5.3 was cut, and cli/go.mod currently pins v1.5.2, so this should merge only once the dependency is released and bumped. Signed-off-by: Amrendra Vikram Singh <76041208+AmrendraTheCoder@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two gaps in
dirctl import --help, both about things the CLI can do but does not tell you about.Directory input. agntcy/dir-importer#87 added directory support for the
mcp,a2aandoasfimport types, so--file-pathcan now point at a folder of*.jsonfiles instead of a single file. The help still describes it as a JSON file only.The
oasftype. This one predates that work.--typebinds to a plain string which is handed straight toconfig.ImportTypewith no allowlist in the CLI:and
dir-importer'sconfig.Validate()acceptsoasf. So--type=oasfhas been working, but it appeared in neither the kinds list, the--typeflag description, nor the command summary. There was no way to find it from the CLI.Please do not merge yet
This documents behaviour that only ships with a
dir-importerrelease containing agntcy/dir-importer#87. That change merged a few hours afterv1.5.3was cut, andcli/go.modcurrently pinsv1.5.2:So the directory wording is accurate against
dir-importermain, but not against the version this module builds with today. Opening as a draft so it is ready to go, but it should land only after a release containing #87 and a bump here. Happy to add thego.modbump to this PR once such a release exists, or to split theoasfhalf out if you would rather have that part now, since it is correct againstv1.5.2already.Rendered output
Also adds
dirctl import --type=a2a --file-path=./agent-cards/to the examples, and updates the--file-pathand--typeflag descriptions to match.Docs only, no behaviour change. Verified by building the CLI and reading back
dirctl import --help.