Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (taskin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Taskin
Task management system integrated with Git workflows
Taskin is a command-line tool that helps you manage tasks directly from your terminal, with seamless Git integration and dynamic provider loading.
โจ Features
- ๐ฏ Multiple Task Providers - File System, Redmine, Jira, GitHub Issues (and more!)
- ๐ Dynamic Provider Installation - Automatically installs providers when needed
- ๐ฆ Lightweight CLI - Only installs what you use
- ๐ Secure Configuration - API keys protected in
.gitignore - ๐จ Beautiful CLI - Colorful, interactive, and user-friendly
- โก Fast & Efficient - Built with performance in mind
- ๐งช Well Tested - Comprehensive test coverage
๐ Installation
```bash
Using npx (recommended - no installation needed!)
npx taskin init
Or install globally
npm install -g taskin
Or with pnpm
pnpm add -g taskin
Or with yarn
yarn global add taskin ```
Note: This is a beta version. Please report any issues on GitHub.
Quick Start
Initialize Taskin in your project: ```bash npx taskin init ```
Select your preferred task provider:
- ๐ File System - Store tasks as Markdown files locally
- ๐ด Redmine - Sync with Redmine issues (coming soon)
- ๐ต Jira - Sync with Jira issues (coming soon)
- ๐ GitHub Issues - Sync with GitHub (coming soon)
List all tasks: ```bash taskin list ```
Start working on a task: ```bash taskin start task-001 ```
Commands
- `taskin init` - Initialize Taskin in your project with interactive setup
- `taskin list` - List all tasks
- `taskin start
` - Start working on a task - `taskin pause
` - Pause work on a task - `taskin finish
` - Complete a task - `taskin lint` - Validate task files
๐๏ธ Architecture
Taskin uses a plugin-based architecture with dynamic provider loading:
- Providers are loaded on-demand (only when selected)
- Automatic installation via npm/pnpm/yarn
- Easy to extend with custom providers
๐ See ARCHITECTURE.md for detailed technical documentation.
๐ Examples
See EXAMPLES.md for detailed usage examples and workflows.
๐ Available Providers
| Provider | Status | Package |
|---|---|---|
| ๐ File System | โ Stable | `@taskin/fs-task-provider` |
| ๐ด Redmine | ๐ง Coming Soon | `@taskin/redmine-task-provider` |
| ๐ต Jira | ๐ง Coming Soon | `@taskin/jira-task-provider` |
| ๐ GitHub Issues | ๐ง Coming Soon | `@taskin/github-task-provider` |
Want to create your own provider? See ARCHITECTURE.md.
๐ค Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
๐ Requirements
- Node.js >= 20.0.0
- npm/pnpm/yarn
๐ Issues
Found a bug? Have a feature request? Please open an issue.
๏ฟฝ Team
OpenTask
- Website: opentask.com.br
- Email: contato@opentask.com.br
Contributors:
- Sidarta Veloso (@sidartaveloso)
๐ License
MIT ยฉ OpenTask