Skip to content

Document agent self-setup - #57

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

Document agent self-setup#57
dimavrem22 wants to merge 1 commit into
mainfrom
docs/agent-self-setup

Conversation

@dimavrem22

Copy link
Copy Markdown
Contributor

Executive Summary

Documents a complete self-setup flow for agents connecting an already-assigned Inkbox identity to Claude Code.

  • Uses the repository installer without opening the interactive setup wizard.
  • Keeps credentials private while preserving the assigned identity across resumable bootstrap attempts.
  • Explains human-action handoff, error recovery, signing-key impact, and doctor verification.

Description

Expands the README's non-interactive bootstrap section into an agent-executable sequence. The guidance covers inspecting and running the repository installer, supplying credentials through a private runtime mechanism, saving configuration in per-user bridge state, and invoking every required bootstrap flag.

It also documents the JSON result states, resuming the same command after a requested human action or corrected error, and verifying a configured installation with inkbox-claude doctor.

Reason

Agents given an existing identity and credential need enough standalone guidance to install and configure the official integration safely without switching to a separate identity or setup flow.

Decisions

  • Credential handling: The documented flow keeps the credential out of command arguments, source control, project files, and agent instructions because setup must not expose reusable secrets.
  • Recovery behavior: Human actions and errors resume the same bootstrap command so partial setup preserves the assigned identity and existing progress.

Testing

  • UV_CACHE_DIR=/tmp/claude-plugin-uv-cache uv run --with pytest python -m pytest tests/test_bootstrap.py tests/test_doctor.py: 5 passed.
  • UV_CACHE_DIR=/tmp/claude-plugin-uv-cache uv run python -m inkbox_claude.cli bootstrap --help and doctor --help: both command parsers completed successfully.
  • Documented bootstrap shell example: bash -n syntax validation passed.
  • git diff --check: passed.
  • README self-setup flow: reviewers should confirm the example preserves the supplied identity, uses every required bootstrap flag, handles requires_human and error results by retrying the same flow, and ends with inkbox-claude doctor.

@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