Document safe agent self-setup - #58
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Executive Summary
Documents a safe, complete self-setup flow for agents connecting an assigned Inkbox identity to Claude Code.
Description
Expands the README's unattended bootstrap guidance into an agent-executable sequence. The installation example downloads the repository installer once, displays that exact artifact, executes it with
--no-setup, and removes the temporary file on success or failure.The guide supplies the complete host-specific bootstrap command with shell-safe placeholders, documents each JSON result state, and explains how to resume the same command after a requested human action or corrected error before verifying setup with
inkbox-claude doctor.Reason
Agents given an existing identity and credential need standalone guidance to install and configure the integration safely without switching identities or exposing reusable secrets.
Decisions
Testing
inkbox-claude doctorreporting the configured integration.python3 -m pytest -q tests/test_bootstrap.py tests/test_doctor.py: 5 passed.bash -n install.shandbash install.sh --help: passed; the installer exposes--no-setup.python3 -m inkbox_claude.cli bootstrap --helpandpython3 -m inkbox_claude.cli doctor --help: passed; the documented commands and bootstrap flags are registered.bashblocks parsed successfully withbash -n.git diff --check: passed before and after rebasing ontoorigin/main.