Website: cli.nylas.com
Quick navigation guide to find the right documentation for your needs.
- First-time setup →
nylas init(details) - Learn about Nylas CLI → README.md
- Quick command reference → COMMANDS.md
- See examples → COMMANDS.md and commands/
- Architecture overview → ARCHITECTURE.md
- File structure → CLAUDE.md
- Set up development environment → DEVELOPMENT.md
- Testing guidelines → .claude/rules/testing.md
- Go quality & linting → .claude/rules/go-quality.md
- Contributing guidelines → CONTRIBUTING.md
- Add a CLI command → .claude/commands/add-command.md
- Add an API method → .claude/commands/add-api-method.md
- Add a domain type → .claude/commands/add-domain-type.md
- Add a command flag → .claude/commands/add-flag.md
- Generate CRUD command → .claude/commands/generate-crud-command.md
- Run tests → .claude/commands/run-tests.md
- Add integration test → .claude/commands/add-integration-test.md
- Debug test failure → .claude/commands/debug-test-failure.md
- Analyze coverage → .claude/commands/analyze-coverage.md
- Testing guidelines → .claude/rules/testing.md
- Fix build errors → .claude/commands/fix-build.md
- Debug test failure → .claude/commands/debug-test-failure.md
- Troubleshooting guide → troubleshooting/
- Security scan → .claude/commands/security-scan.md
- Security guidelines → security/overview.md
- Code review → .claude/commands/review-pr.md
- Go quality & linting → .claude/rules/go-quality.md
- File size limits → .claude/rules/file-size-limits.md
- Update documentation → .claude/commands/update-docs.md
- Documentation rules → .claude/rules/documentation-maintenance.md
- Go quality rules → .claude/rules/go-quality.md
- Email → commands/email.md
- Email signing (GPG) → commands/email-signing.md
- Email encryption → commands/encryption.md
- GPG explained → commands/explain-gpg.md
- Calendar → commands/calendar.md
- Contacts → commands/contacts.md
- Webhooks → commands/webhooks.md
- Agent accounts → commands/agent.md
- Scheduler → commands/scheduler.md
- Admin → commands/admin.md
- Timezone → commands/timezone.md
- Audit → commands/audit.md
- TUI → commands/tui.md
- Workflows (OTP) → commands/workflows.md
- Templates → commands/templates.md
- Slack → COMMANDS.md#slack-integration
- AI features → commands/ai.md
- MCP integration → commands/mcp.md
- AI configuration → ai/configuration.md
- AI providers → ai/providers.md
- AI privacy → ai/privacy-security.md
- AI best practices → ai/best-practices.md
- AI architecture → ai/architecture.md
- AI features list → ai/features.md
- AI FAQ → ai/faq.md
- AI troubleshooting → ai/troubleshooting.md
- Adding commands → development/adding-command.md
- Adding adapters → development/adding-adapter.md
- Testing guide → development/testing-guide.md
- Debugging → development/debugging.md
- Security overview → security/overview.md
- Security practices → security/practices.md
- FAQ → troubleshooting/faq.md
- Auth issues → troubleshooting/auth.md
- API issues → troubleshooting/api.md
- Email issues → troubleshooting/email.md
- Timezone issues → troubleshooting/timezone.md
docs/
├── INDEX.md # This file - start here
├── COMMANDS.md # CLI quick reference
├── ARCHITECTURE.md # System design
├── DEVELOPMENT.md # Development setup
│
├── commands/ # Detailed command guides (16 files)
│ ├── ai.md # AI features
│ ├── mcp.md # MCP integration
│ ├── calendar.md # Calendar events
│ ├── email.md # Email operations
│ ├── email-signing.md # GPG/PGP email signing
│ ├── encryption.md # Email encryption
│ ├── explain-gpg.md # GPG explained
│ ├── contacts.md # Contact management
│ ├── webhooks.md # Webhook setup
│ ├── scheduler.md # Booking pages
│ ├── admin.md # API management
│ ├── timezone.md # Timezone utilities
│ ├── audit.md # Audit logging & invoker tracking
│ ├── tui.md # Terminal UI
│ ├── templates.md # Email templates
│ └── workflows.md # OTP & automation
│
├── ai/ # AI configuration (8 files)
│ ├── configuration.md # Setup guide
│ ├── providers.md # Provider options
│ ├── privacy-security.md # Privacy controls
│ └── ...
│
├── development/ # Dev guides (4 files)
│ ├── adding-command.md # Add CLI commands
│ ├── adding-adapter.md # Add API adapters
│ ├── testing-guide.md # Testing patterns
│ └── debugging.md # Debug tips
│
├── security/ # Security (2 files)
│ ├── overview.md # Quick reference
│ └── practices.md # Detailed practices
│
├── troubleshooting/ # Debug guides (5 files)
│ ├── faq.md # Common questions
│ ├── auth.md # Auth issues
│ ├── api.md # API errors
│ ├── email.md # Email issues
│ └── timezone.md # Timezone issues
│
└── images/ # Screenshots (5 PNGs)
- README.md - Project overview
- CONTRIBUTING.md - How to contribute
- DEVELOPMENT.md - Setup instructions
- CLAUDE.md - Code navigation
- ARCHITECTURE.md - Understand the design
- .claude/commands/add-command.md - Add CLI commands
- .claude/rules/testing.md - Testing requirements
- .claude/rules/documentation-maintenance.md - Doc updates
- .claude/commands/debug-test-failure.md - Test debugging
- troubleshooting/ - Common issues & FAQ
- .claude/commands/fix-build.md - Fix build errors
- .claude/commands/security-scan.md - Security checks
- .claude/commands/review-pr.md - PR review
- .claude/rules/go-quality.md - Go quality & linting
- README.md - Getting started
- COMMANDS.md - Command reference
- cli.nylas.com/guides - Step-by-step tutorials
- troubleshooting/faq.md - Common questions
- For AI (Claude): Most docs are in CLAUDE.md and .claude/ directory
- For humans: Start with README.md and COMMANDS.md
- Need help? Check troubleshooting/faq.md
- Adding code? Follow workflows in .claude/commands/
- Security concern? See security/overview.md
Last Updated: February 5, 2026