nullkey
da9faa9e07
Borrows the lark-cli agent-affordance model (https://github.com/larksuite/cli/blob/main/AGENTS.md + skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly: error messages, output format, and flag design follow conventions agents can rely on. cli/AGENTS.md (operational reference for LLM agents invoking weknora): Public document covering envelope schema, exit-code protocol (0/1/2/10/130), stdout/stderr separation, and behavioral rules. Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`) gain "AI agents:" paragraphs in their cobra Long descriptions so guidance shows in --help. format.Envelope schema additions: Risk per-operation classification (read / write / high-risk-write + action description), populated by write commands on both success and failure paths. Notice system advisories (CLI update available, server-CLI version skew); type defined, emit sites land in v0.3. DryRun marker for envelopes returned from --dry-run preview paths. RiskLevel constants realigned to lark's taxonomy: read / write / high-risk-write (was: read / mutating / destructive — not yet wired by any command). cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it to envelope.Risk so destructive failure paths surface uniformly. Exit-10 confirmation protocol: New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in cmdutil.ExitCode. ConfirmDestructive now returns this code (with OperationRisk attached) when stdout is non-TTY or --json was set, with -y/--yes absent. Previous behavior — silent proceed in non-TTY — was unsafe: scripts and agents could delete resources with no explicit approval. Three test cases re-pinned around the new contract. This is a wire-contract change for any caller who relied on silent proceed; v0.0/v0.1 had no destructive commands, so the blast radius is contained to v0.2 itself. --dry-run global flag: cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/ DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an envelope with dry_run=true plus a Risk classification. Read commands ignore --dry-run by design (no side effect to preview). Human-mode prints \`[dry-run] would <action>\` to stdout. Command discovery: agents introspect via the existing \`--help\` surface (consistent with gh / kubectl / aws / gcloud / terraform — none of them ship a CLI-tree self-description command). An earlier draft added a \`weknora schema\` reflection command; dropped after a mainstream survey found it has no stable analog (lark-cli's schema describes Lark API methods, not its own CLI tree). Tests: 27 cli packages pass at this commit. Added two new tests covering envelope.risk and envelope._notice serialization.
46 lines
1.4 KiB
Go
46 lines
1.4 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// IsDryRun reports whether the global --dry-run flag was set on cmd or any
|
|
// of its parents. Write commands check this and skip the SDK call, returning
|
|
// an envelope with dry_run=true that describes the action that would have
|
|
// run. Read commands ignore --dry-run (no side effect to preview).
|
|
//
|
|
// Pattern from lark-cli's `--dry-run` (cmd/api/api.go DryRun field).
|
|
func IsDryRun(cmd *cobra.Command) bool {
|
|
if cmd == nil {
|
|
return false
|
|
}
|
|
v, _ := cmd.Flags().GetBool("dry-run")
|
|
return v
|
|
}
|
|
|
|
// EmitDryRun writes the canonical preview envelope for a write command. JSON
|
|
// mode emits SuccessWithRisk + DryRun=true; human mode prints the
|
|
// `[dry-run] would <risk.Action>` line to stdout, with " (high-risk)"
|
|
// appended automatically when risk.Level == RiskHighRiskWrite. Centralized
|
|
// so wire shape stays identical across kb create/delete, doc upload/delete,
|
|
// api, and any future write command.
|
|
func EmitDryRun(jsonOut bool, data any, meta *format.Meta, risk *format.Risk) error {
|
|
out := iostreams.IO.Out
|
|
if jsonOut {
|
|
env := format.SuccessWithRisk(data, meta, risk)
|
|
env.DryRun = true
|
|
return format.WriteEnvelope(out, env)
|
|
}
|
|
line := risk.Action
|
|
if risk.Level == format.RiskHighRiskWrite {
|
|
line += " (high-risk)"
|
|
}
|
|
_, err := fmt.Fprintf(out, "[dry-run] would %s\n", line)
|
|
return err
|
|
}
|