docs: create comprehensive documentation suite#11
Merged
Conversation
This restructures the codebase from a flat cmd/ layout to a modular, testable architecture with proper separation of concerns. Changes: - Create public api/ package with types, errors, and domain-specific files - Create internal/cmd/ with Options pattern for all commands - Create internal/view/ for output formatting (table/json/plain) - Create internal/version/ for build-time version injection - Rename internal/keychain/ to internal/config/ - Move entry point to cmd/newrelic-cli/main.go - Replace --json flag with --output/-o (table|json|plain) - Add --no-color global flag - Update Makefile with new targets and ldflags - Add unit tests for view, version, and api packages The new structure enables: - Testable commands via Options struct and injectable clients - Public API package that can be imported by other Go projects - Consistent output formatting across all commands - Better separation between CLI, business logic, and API Closes #1 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- README.md: Complete rewrite with exhaustive command reference, configuration details, scripting examples, and Go library usage - CLAUDE.md: AI agent guidance document with architecture, patterns, and workflows - CONTRIBUTING.md: Developer onboarding guide with setup, style, and contribution process - docs/integration-tests.md: Manual verification checklist for all commands and edge cases Closes #2 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
piekstra
approved these changes
Jan 13, 2026
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
2 participants
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.
Summary
Changes
README.mdCLAUDE.mdCONTRIBUTING.mddocs/integration-tests.mdAcceptance Criteria
Test plan
make buildsucceedsmake testpassesCloses #2
Generated with Claude Code