Skip to content

Document agent self-setup for assigned identities - #22

Closed
dimavrem22 wants to merge 1 commit into
mainfrom
docs/agent-self-setup
Closed

Document agent self-setup for assigned identities#22
dimavrem22 wants to merge 1 commit into
mainfrom
docs/agent-self-setup

Conversation

@dimavrem22

Copy link
Copy Markdown
Contributor

Executive Summary

Documents a complete agent-executable setup flow for an assigned Inkbox identity in OpenCode.

  • Uses an inspect-before-execute installation flow without opening interactive setup.
  • Explains private credential handling and the exact non-interactive bootstrap command.
  • Covers resumable human actions, error recovery, and doctor verification.

Description

The README now guides an agent from reviewing and installing the plugin through bootstrapping an already-assigned identity with the required base URL, project directory, Voice AI, signing-key rotation, and gateway options.

It also documents the bootstrap JSON statuses, including how to resume the same command after a requested human action, diagnose redacted errors without changing identities, and verify the resulting configuration with inkbox-opencode doctor.

Reason

Agents need a safe, complete setup path that preserves the identity assigned by a human and can recover from interruptions without falling back to signup or creating a replacement identity.

Decisions

  • Installation safety: Download, display, and execute the same temporary installer artifact so an agent can inspect exactly what it runs.
  • Recovery behavior: Resume the same bootstrap command and assigned identity after human actions or corrected errors so setup remains deterministic and resumable.

Testing

  • npm test -- tests/cli/bootstrap.test.ts tests/cli/doctor.test.ts tests/cli/index.test.ts: 30 focused CLI tests passed.
  • npm run build: TypeScript build passed.
  • bash -n install.sh: Installer syntax validation passed.
  • git diff --check: README diff passed whitespace validation.
  • README bootstrap flow: Expected install, bootstrap status handling, and inkbox-opencode doctor verification commands are documented with shell-safe placeholders.

@dimavrem22
dimavrem22 marked this pull request as ready for review August 7, 2026 20:20
@dimavrem22 dimavrem22 closed this Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant