Skip to content

Commit f3274ae

Browse files
author
Test User
committed
chore: prepare v0.0.1-alpha as first release
- Update version to 0.0.1-alpha - Reset CHANGELOG.md to initial release - Add comprehensive release notes with all CLI commands - Include future roadmap in release notes - Remove all previous release tags
1 parent 34912cc commit f3274ae

File tree

3 files changed

+154
-36
lines changed

3 files changed

+154
-36
lines changed

.goreleaser.yml

Lines changed: 149 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -110,23 +110,155 @@ release:
110110
header: |
111111
## Release Notes
112112
113-
**DoPlan CLI v0.1.1-alpha - Initial Release**
113+
**DoPlan CLI v0.0.1-alpha - First Release**
114114
115115
This is the first alpha release of DoPlan CLI, a comprehensive project workflow automation tool that transforms app ideas into structured development projects.
116116
117-
### Key Features
118-
- Project workflow automation with IDE integration
119-
- GitHub integration for automatic branching and PR management
120-
- Real-time progress tracking with visual dashboards
121-
- Document generation (PRD, project structure, API contracts)
122-
- Interactive TUI dashboard
123-
- Statistics and analytics with historical tracking
124-
- Checkpoint system for project snapshots
125-
126-
### Installation
127-
- Download binaries for Linux, macOS, and Windows (amd64 and arm64)
128-
- Install via npm: `npm install -g doplan-cli`
129-
- Homebrew support coming soon
130-
131-
### Documentation
132-
See [README.md](https://github.com/DoPlan-dev/CLI/blob/master/README.md) for full documentation.
117+
### 🎉 What is DoPlan?
118+
119+
DoPlan automates the tedious aspects of project management by generating documentation, creating project structures, managing Git workflows, tracking progress, and providing visual dashboards. It enforces best practices through automated rules, templates, and checkpoints, ensuring your project stays organized and maintainable throughout its development.
120+
121+
### ✨ Key Features
122+
123+
- **Project Workflow Automation**: Transform app ideas into structured development projects
124+
- **IDE Integration**: Support for Cursor, Gemini CLI, Claude CLI, Codex CLI, OpenCode, and Qwen Code
125+
- **GitHub Integration**: Automatic branch creation, commit tracking, and PR management
126+
- **Progress Tracking**: Real-time progress monitoring with visual dashboards
127+
- **Document Generation**: Auto-generate PRD, project structure, API contracts, and planning documents
128+
- **Interactive TUI**: Fullscreen terminal user interface with interactive dashboard
129+
- **Statistics & Analytics**: Comprehensive project insights with historical tracking
130+
- **Checkpoint System**: Create, list, and restore project checkpoints (Time Machine)
131+
132+
### 📦 Installation
133+
134+
**npm (Recommended for Node.js users):**
135+
```bash
136+
npm install -g doplan-cli
137+
```
138+
139+
**Binary Release:**
140+
Download the latest release for your platform from the [releases page](https://github.com/DoPlan-dev/CLI/releases):
141+
- Linux (amd64, arm64)
142+
- macOS (amd64, arm64)
143+
- Windows (amd64, arm64)
144+
145+
**Package Managers:**
146+
- Debian/Ubuntu: `.deb` packages available
147+
- RHEL/CentOS: `.rpm` packages available
148+
- Homebrew: Coming soon
149+
150+
### 🚀 CLI Commands
151+
152+
#### Main Commands
153+
154+
| Command | Description |
155+
|---------|-------------|
156+
| `doplan install` | Install DoPlan in your project (interactive IDE selection) |
157+
| `doplan dashboard` | View project dashboard with progress and GitHub activity |
158+
| `doplan --tui` | Launch fullscreen interactive TUI dashboard |
159+
| `doplan github` | Sync GitHub data (branches, commits, PRs) and update dashboard |
160+
| `doplan progress` | Update all progress tracking files and regenerate dashboard |
161+
| `doplan validate` | Validate project structure, configuration, and state consistency |
162+
163+
#### Configuration Commands
164+
165+
| Command | Description |
166+
|---------|-------------|
167+
| `doplan config show` | Show current configuration (table or JSON format) |
168+
| `doplan config set <key> <value>` | Set a configuration value |
169+
| `doplan config reset` | Reset configuration to defaults |
170+
| `doplan config validate` | Validate configuration settings |
171+
172+
**Configuration Keys:**
173+
- `github.enabled` - Enable/disable GitHub integration
174+
- `github.autoBranch` - Auto-create branches for features
175+
- `github.autoPR` - Auto-create PRs when features complete
176+
- `checkpoint.autoFeature` - Auto-checkpoint when feature starts
177+
- `checkpoint.autoPhase` - Auto-checkpoint when phase starts
178+
- `checkpoint.autoComplete` - Auto-checkpoint when feature/phase completes
179+
180+
#### Checkpoint Commands
181+
182+
| Command | Description |
183+
|---------|-------------|
184+
| `doplan checkpoint create [name]` | Create a manual checkpoint |
185+
| `doplan checkpoint list` | List all checkpoints |
186+
| `doplan checkpoint restore <id>` | Restore a checkpoint |
187+
188+
**Checkpoint Options:**
189+
- `--type <type>` - Checkpoint type: `manual`, `feature`, `phase`
190+
- `--description <text>` - Add description to checkpoint
191+
192+
#### Template Commands
193+
194+
| Command | Description |
195+
|---------|-------------|
196+
| `doplan templates list` | List all available templates |
197+
| `doplan templates show <name>` | Show template content |
198+
| `doplan templates add <name> <file>` | Add a template from file |
199+
| `doplan templates edit <name>` | Edit template (opens in default editor) |
200+
| `doplan templates use <name> [--for type]` | Set default template (plan/design/tasks) |
201+
| `doplan templates remove <name>` | Remove a template |
202+
203+
#### IDE Integration Commands
204+
205+
After installation, use these commands in your IDE:
206+
207+
**In Cursor/Gemini/Claude/Codex/OpenCode/Qwen:**
208+
- `/Discuss` - Start idea discussion and refinement
209+
- `/Plan` - Generate project plan and structure
210+
- `/Design` - Create design documents
211+
- `/Implement` - Begin feature implementation
212+
- `/Progress` - Update progress tracking
213+
- `/Next` - Get next action recommendation
214+
215+
### 🗺️ Roadmap
216+
217+
#### v0.1.0 (Beta Release)
218+
- [ ] Homebrew tap repository setup
219+
- [ ] Enhanced TUI with keyboard navigation
220+
- [ ] Web dashboard (optional web interface)
221+
- [ ] Plugin system for custom integrations
222+
- [ ] Export/import project configurations
223+
- [ ] Multi-project workspace support
224+
225+
#### v0.2.0 (Stable Release)
226+
- [ ] Cloud sync for project data
227+
- [ ] Team collaboration features
228+
- [ ] Advanced analytics and reporting
229+
- [ ] Integration with more IDEs and tools
230+
- [ ] Custom workflow templates marketplace
231+
- [ ] API for programmatic access
232+
233+
#### v1.0.0 (Production Ready)
234+
- [ ] Full documentation and tutorials
235+
- [ ] Performance optimizations
236+
- [ ] Enterprise features
237+
- [ ] Security audit and hardening
238+
- [ ] Official IDE extensions
239+
- [ ] Community templates and plugins
240+
241+
### 📚 Documentation
242+
243+
- **Full Documentation**: [README.md](https://github.com/DoPlan-dev/CLI/blob/master/README.md)
244+
- **Installation Guide**: See README Installation section
245+
- **Getting Started**: See README "How to Start" section
246+
- **Contributing**: [CONTRIBUTING.md](https://github.com/DoPlan-dev/CLI/blob/master/CONTRIBUTING.md)
247+
248+
### 🐛 Known Issues
249+
250+
- Homebrew tap repository is not yet set up (binaries available via direct download)
251+
- Some IDE integrations may require manual configuration
252+
- TUI dashboard is optimized for terminals with 80+ columns
253+
254+
### 🤝 Contributing
255+
256+
We welcome contributions! Please see [CONTRIBUTING.md](https://github.com/DoPlan-dev/CLI/blob/master/CONTRIBUTING.md) for guidelines.
257+
258+
### 📄 License
259+
260+
MIT License - see [LICENSE](https://github.com/DoPlan-dev/CLI/blob/master/LICENSE) file for details.
261+
262+
### 🙏 Acknowledgments
263+
264+
Thank you for trying DoPlan CLI! This is an alpha release, and we'd love your feedback.

CHANGELOG.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10-
## [0.1.3a-alpha] - 2025-11-14
11-
12-
### Fixed
13-
- Ensured NODE_AUTH_TOKEN is properly configured in npm publish workflow
14-
- Added token to setup-node step for early authentication
15-
16-
## [0.1.2-alpha] - 2025-11-14
17-
18-
### Fixed
19-
- Fixed npm publish workflow build script issue
20-
- Simplified build.js script for npm package preparation
21-
22-
## [0.1.1-alpha] - 2025-11-14
10+
## [0.0.1-alpha] - 2025-11-14
2311

2412
### Initial Release
2513

26-
This is the first alpha release of DoPlan CLI.
14+
This is the first alpha release of DoPlan CLI, a comprehensive project workflow automation tool that transforms app ideas into structured development projects.
2715

2816
### Features
2917
- **Project Workflow Automation**: Transform app ideas into structured development projects
@@ -58,7 +46,5 @@ This is the first alpha release of DoPlan CLI.
5846
- Contribution guidelines
5947
- Release process documentation
6048

61-
[Unreleased]: https://github.com/DoPlan-dev/CLI/compare/v0.1.3a-alpha...HEAD
62-
[0.1.3a-alpha]: https://github.com/DoPlan-dev/CLI/releases/tag/v0.1.3a-alpha
63-
[0.1.2-alpha]: https://github.com/DoPlan-dev/CLI/releases/tag/v0.1.2-alpha
64-
[0.1.1-alpha]: https://github.com/DoPlan-dev/CLI/releases/tag/v0.1.1-alpha
49+
[Unreleased]: https://github.com/DoPlan-dev/CLI/compare/v0.0.1-alpha...HEAD
50+
[0.0.1-alpha]: https://github.com/DoPlan-dev/CLI/releases/tag/v0.0.1-alpha

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "doplan-cli",
3-
"version": "0.1.3a-alpha",
3+
"version": "0.0.1-alpha",
44
"description": "Project workflow automation tool that transforms app ideas into well-structured, documented, and trackable development projects",
55
"main": "index.js",
66
"bin": {

0 commit comments

Comments
 (0)