Skip to content

Clarify that bare kanon import is preview-only and writes nothing #55

Description

@kelos-bot

When I tried the first-run flow in a fresh home, kanon import without --write did not import into kanon.yaml; it printed the normalized config to stdout instead, along with warnings about skipped fields.

Repro:

  1. kanon init --home /tmp/kanon-home
  2. kanon import --home /tmp/kanon-home --agent all

Observed:

  • stdout contains YAML for the imported config
  • warnings are emitted for skipped/secret fields
  • nothing is written to the Kanon home unless --write is added

Why this is confusing:

  • the command name reads like a write operation
  • import --help documents --write, but does not say that bare import is preview-only
  • the README examples focus on --ui and --write, so a user who tries the plain command may think it failed or is interactive

Suggestion:

  • add an explicit note to kanon import --help and the README that bare kanon import is a non-writing preview that prints the normalized source to stdout
  • optionally include a short example showing kanon import --write as the default way to persist the result

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions