Skip to content

[Doc Drift] README.md apiops init flags table missing --artifact-dir option #194

Description

@github-actions

What drifted

The apiops init flags table in README.md is missing the --artifact-dir <dir> option. This flag controls the artifact directory path referenced in generated CI/CD pipeline files (default: ./apim-artifacts). It is present in the CLI --help output and fully documented in docs/commands/init.md, but the README quick-reference table lists only 5 of the 6 init flags and silently omits this one.

Source of truth

apiops init --help output includes:

--artifact-dir <dir>      Artifact directory path (default:
                          "./apim-artifacts")

docs/commands/init.md (line 49) correctly documents it:

| `--artifact-dir <dir>` | string | `./apim-artifacts` | No | Artifact directory path |

Affected documentation

  • README.md — the apiops init flags table (the | Flag | Description | table under ### \apiops init``)

Suggested update

Add --artifact-dir <dir> as a row in the README's init flags table, e.g.:

Flag Description
--artifact-dir <dir> Artifact directory path (default: ./apim-artifacts)
--cli-package <path> Path to a local .tgz tarball
--ci <platform> github-actions or azure-devops
--environments <list> Comma-separated environments (e.g. dev,prod)
--non-interactive Skip all prompts
--force Overwrite existing files

Generated by Documentation Freshness Check — System Policy · 42 AIC · ⌖ 9.17 AIC · ⊞ 6.1K ·

Metadata

Metadata

Assignees

Labels

close:fixedFixed by a previous PR or releasego:yesReady to implementsquadSquad triage inbox — Lead will assign to a membersquad:copilotAssigned to @copilot (Coding Agent) for autonomous worksquad:docwriterAssigned to DocWriter (📝 Technical Writer)type:documentationDocumentation issues or requests

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions