Skip to content

Not all CLI commands being documented #2010

@tas50

Description

@tas50

Describe the bug
When running: go run apps/gen-docs/main.go --docs-path ../docs/docs/cnspec/cli/. the following docs are generated:

_category_.json               cnspec_logout.md              cnspec_policy_lint.md         cnspec_serve.md
cnspec_framework_active.md    cnspec_migrate.md             cnspec_policy_list.md         cnspec_status.md
cnspec_framework_disabled.md  cnspec_policy_delete.md       cnspec_policy_upload.md       cnspec_vault_add-secret.md
cnspec_framework_download.md  cnspec_policy_disable.md      cnspec_policy.md              cnspec_vault_configure.md
cnspec_framework_list.md      cnspec_policy_download.md     cnspec_providers_install.md   cnspec_vault.md
cnspec_framework_preview.md   cnspec_policy_enable.md       cnspec_providers_list.md      cnspec_version.md
cnspec_framework_upload.md    cnspec_policy_format.md       cnspec_providers.md           cnspec.md
cnspec_framework.md           cnspec_policy_info.md         cnspec_run.md
cnspec_login.md               cnspec_policy_init.md         cnspec_scan.md

This does not match the commands from help:

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  framework   Manage local and Mondoo Platform hosted compliance frameworks
  help        Help about any command
  login       Register with Mondoo Platform
  logout      Log out from Mondoo Platform
  migrate     Migrate cnspec CLI configuration to the latest version
  policy      Manage local and upstream policies
  providers   Providers add connectivity to all assets
  run         Run an MQL query
  scan        Scan assets with one or more policies
  serve       Start cnspec in background mode
  shell       Interactive query shell for MQL
  status      Verify access to Mondoo Platform
  vault       Manage vault environments
  version     Display the cnspec version
  vuln        Scans a target for vulnerabilities

In particular we need to make sure that vuln and shell are documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions