Prepare @agents-dev/cli for first public release - #2
Merged
Conversation
- Clean README: remove agent/agents confusion, Kimi, Continue.dev, Aider mentions - Add comprehensive documentation structure: - docs/QUICK_START.md: 5-minute getting started guide - docs/EXAMPLES.md: 7+ real-world usage scenarios - docs/PUBLISHING.md: maintainer release guide - docs/SHOW_HN.md: launch templates (HN, Twitter, Reddit) - docs/README.md: documentation navigation - Add CONTRIBUTING.md: contribution guidelines - Add LAUNCH_CHECKLIST.md: pre-launch validation steps - Update package.json: rename to agents-standard, add keywords and repo links - Fix flaky test: increase timeout for mcp-test-runtime integration test Ready for npm publish and public launch.
- Add AGENTS.md: comprehensive guide for AI agents working on this project - Project overview and tech stack - Development workflow and testing guidelines - Key concepts (sync, renderers, MCP, trust, file safety) - Common tasks and patterns - Security and performance tips - Move internal docs to .docs-internal/ (gitignored): - LAUNCH_CHECKLIST.md (pre-launch validation) - PUBLISHING.md (npm release guide) - SHOW_HN.md (marketing templates) - README.md (internal docs navigation) - Update .gitignore: add .docs-internal/ - Update package.json files: include AGENTS.md and CONTRIBUTING.md in npm package - Update docs/README.md: remove internal doc links Public docs structure: - README.md, AGENTS.md, CONTRIBUTING.md, CHANGELOG.md (root) - docs/QUICK_START.md, EXAMPLES.md, agents-system.md Internal docs (maintainer only, not in git/npm): - .docs-internal/PUBLISHING.md, SHOW_HN.md, LAUNCH_CHECKLIST.md
- Remove QUICK_START.md (redundant with README) - Simplify all docs to match README style: - Short sections - More tables - Less text - Clear structure - Updated docs: - EXAMPLES.md: 212 lines (was 588) - CONTRIBUTING.md: 165 lines (was 450+) - agents-system.md: 179 lines (was 82, but more structured) - docs/README.md: 27 lines (was 70) Final structure: - Root: README.md, AGENTS.md, CONTRIBUTING.md, CHANGELOG.md - docs/: EXAMPLES.md, agents-system.md, README.md - .docs-internal/: PUBLISHING.md, SHOW_HN.md, LAUNCH_CHECKLIST.md (gitignored)
- Update package.json: name changed to @agents-dev/cli - Update README.md: npm badge and install command - Update AGENTS.md: all references to new name - Update docs/EXAMPLES.md: CI/CD example - Update .docs-internal/: all internal docs New install command: npm install -g @agents-dev/cli All tests passing: 77/77 ✅
- Detect GitHub repository URLs
- Show helpful message with example how to add manually
- Suggest checking mcpservers.org
Before:
'Could not extract MCP JSON payload from URL...'
After:
'Cannot import MCP config directly from GitHub repository.
To add this MCP server, check the README, then use:
agents mcp add <name> --transport stdio --command <cmd>
Example:
agents mcp add figma-mcp --command npx --arg "@figma/mcp-server"
Or try finding it on https://mcpservers.org/'
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
1 participant
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.
This PR prepares the repository for the first public release of @agents-dev/cli. It renames the package from agents-cli-dev to @agents-dev/cli across package metadata and lockfile. It refreshes public docs (README, docs/, CONTRIBUTING, AGENTS.md), moves maintainer docs to .docs-internal, and updates gitignore. It also improves MCP import errors for GitHub repo URLs and stabilizes the runtime integration test timeout.