# IncariCLI
A simple and elegant task manager for your command line. Track your tasks with style using rich formatting and an intuitive interface.
## Features
- ✨ Beautiful terminal UI with color-coded task statuses
- 📝 Create, update, and delete tasks
- 🏷️ Task status management (todo, in-progress, done)
- 📊 List and filter tasks by status
- 💾 JSON-based storage for easy portability
- 🚀 Fast and lightweight
## Installation
### From PyPI
```bash
pip install incaricli
```
### From Source
```bash
git clone https://github.com/paolobtl/incaricli.git
cd incaricli
pip install -e .
```
### For Development
```bash
git clone https://github.com/paolobtl/incaricli.git
cd incaricli
pip install -e ".[dev]"
```
## Usage
### Add a Task
```bash
incaricli add "Complete the project documentation"
```
### List All Tasks
```bash
incaricli list
```
### List Tasks by Status
```bash
# List only todo tasks
incaricli list todo
# List only in-progress tasks
incaricli list in-progress
# List only completed tasks
incaricli list done
```
### Update a Task
```bash
incaricli update 1 "Updated task description"
```
### Change Task Status
```bash
# Mark task as in-progress
incaricli status 1 in-progress
# Mark task as done
incaricli status 1 done
```
### Delete a Task
```bash
incaricli delete 1
```
### Get Help
```bash
incaricli --help
incaricli add --help
```
## Task Statuses
- **todo** (yellow) - Task is pending
- **in-progress** (blue) - Task is currently being worked on
- **done** (green) - Task is completed
## Data Storage
Tasks are stored in a `tasks_db.json` file in your current working directory. This makes it easy to:
- Back up your tasks
- Share task lists with teammates
- Version control your tasks
- Move tasks between machines
## Requirements
- Python 3.10 or higher
- rich >= 13.0.0
## Development
### Setting Up Development Environment
```bash
# Clone the repository
git clone https://github.com/paolobtl/incaricli.git
cd incaricli
# Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in development mode with dev dependencies
pip install -e ".[dev]"
```
### Running Tests
```bash
pytest
```
### Code Formatting
```bash
# Format code with black
black incaricli
# Lint with ruff
ruff check incaricli
# Type check with mypy
mypy incaricli
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Author
**Paolo Bertellotti**
- GitHub: [@paolobtl](https://github.com/paolobtl)
## Acknowledgments
- Built with [Rich](https://github.com/Textualize/rich) for beautiful terminal formatting
- Inspired by various task management tools
## Roadmap
- [ ] Add task priorities
- [ ] Add task due dates
- [ ] Add task categories/tags
- [ ] Export tasks to different formats (CSV, Markdown)
- [ ] Add task search functionality
- [ ] Add task completion statistics
## Support
If you encounter any issues or have questions, please [open an issue](https://github.com/paolobtl/incaricli/issues) on GitHub.
Raw data
{
"_id": null,
"home_page": null,
"name": "incaricli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cli, task-manager, todo, productivity, terminal",
"author": null,
"author_email": "Paolo Bietolini <chat@paolobietolini.com>",
"download_url": "https://files.pythonhosted.org/packages/eb/f6/3668c88755b172d40eefbaf1a7e670d9ad07c1defb4b8d1a82956d3df205/incaricli-0.2.1.tar.gz",
"platform": null,
"description": "# IncariCLI\n\nA simple and elegant task manager for your command line. Track your tasks with style using rich formatting and an intuitive interface.\n\n## Features\n\n- \u2728 Beautiful terminal UI with color-coded task statuses\n- \ud83d\udcdd Create, update, and delete tasks\n- \ud83c\udff7\ufe0f Task status management (todo, in-progress, done)\n- \ud83d\udcca List and filter tasks by status\n- \ud83d\udcbe JSON-based storage for easy portability\n- \ud83d\ude80 Fast and lightweight\n\n## Installation\n\n### From PyPI\n\n```bash\npip install incaricli\n```\n\n### From Source\n\n```bash\ngit clone https://github.com/paolobtl/incaricli.git\ncd incaricli\npip install -e .\n```\n\n### For Development\n\n```bash\ngit clone https://github.com/paolobtl/incaricli.git\ncd incaricli\npip install -e \".[dev]\"\n```\n\n## Usage\n\n### Add a Task\n\n```bash\nincaricli add \"Complete the project documentation\"\n```\n\n### List All Tasks\n\n```bash\nincaricli list\n```\n\n### List Tasks by Status\n\n```bash\n# List only todo tasks\nincaricli list todo\n\n# List only in-progress tasks\nincaricli list in-progress\n\n# List only completed tasks\nincaricli list done\n```\n\n### Update a Task\n\n```bash\nincaricli update 1 \"Updated task description\"\n```\n\n### Change Task Status\n\n```bash\n# Mark task as in-progress\nincaricli status 1 in-progress\n\n# Mark task as done\nincaricli status 1 done\n```\n\n### Delete a Task\n\n```bash\nincaricli delete 1\n```\n\n### Get Help\n\n```bash\nincaricli --help\nincaricli add --help\n```\n\n## Task Statuses\n\n- **todo** (yellow) - Task is pending\n- **in-progress** (blue) - Task is currently being worked on\n- **done** (green) - Task is completed\n\n## Data Storage\n\nTasks are stored in a `tasks_db.json` file in your current working directory. This makes it easy to:\n- Back up your tasks\n- Share task lists with teammates\n- Version control your tasks\n- Move tasks between machines\n\n## Requirements\n\n- Python 3.10 or higher\n- rich >= 13.0.0\n\n## Development\n\n### Setting Up Development Environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/paolobtl/incaricli.git\ncd incaricli\n\n# Create a virtual environment\npython -m venv venv\nsource venv/bin/activate # On Windows: venv\\Scripts\\activate\n\n# Install in development mode with dev dependencies\npip install -e \".[dev]\"\n```\n\n### Running Tests\n\n```bash\npytest\n```\n\n### Code Formatting\n\n```bash\n# Format code with black\nblack incaricli\n\n# Lint with ruff\nruff check incaricli\n\n# Type check with mypy\nmypy incaricli\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Author\n\n**Paolo Bertellotti**\n- GitHub: [@paolobtl](https://github.com/paolobtl)\n\n## Acknowledgments\n\n- Built with [Rich](https://github.com/Textualize/rich) for beautiful terminal formatting\n- Inspired by various task management tools\n\n## Roadmap\n\n- [ ] Add task priorities\n- [ ] Add task due dates\n- [ ] Add task categories/tags\n- [ ] Export tasks to different formats (CSV, Markdown)\n- [ ] Add task search functionality\n- [ ] Add task completion statistics\n\n## Support\n\nIf you encounter any issues or have questions, please [open an issue](https://github.com/paolobtl/incaricli/issues) on GitHub.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple and elegant task manager for your command line",
"version": "0.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/paolobtl/incaricli/issues",
"Homepage": "https://github.com/paolobtl/incaricli",
"Repository": "https://github.com/paolobtl/incaricli"
},
"split_keywords": [
"cli",
" task-manager",
" todo",
" productivity",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "383005d08fc778ccd77a2e02e1c0b8f7e016b71f4a368b9e9be1141943922159",
"md5": "154ac935a319436aade618c6c4d37350",
"sha256": "06f867679110b3fc0f6b7bbe80dc92a6c32b090fc5bafc7caec782943e1e0b66"
},
"downloads": -1,
"filename": "incaricli-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "154ac935a319436aade618c6c4d37350",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6205,
"upload_time": "2025-10-18T17:35:55",
"upload_time_iso_8601": "2025-10-18T17:35:55.110401Z",
"url": "https://files.pythonhosted.org/packages/38/30/05d08fc778ccd77a2e02e1c0b8f7e016b71f4a368b9e9be1141943922159/incaricli-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ebf63668c88755b172d40eefbaf1a7e670d9ad07c1defb4b8d1a82956d3df205",
"md5": "9af8519357a6b3ad66e335a1d9c3bd33",
"sha256": "d510152c2cb43e5352131fcec877d708d22756f3c3b98933a96dac89bd4e1f44"
},
"downloads": -1,
"filename": "incaricli-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "9af8519357a6b3ad66e335a1d9c3bd33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7227,
"upload_time": "2025-10-18T17:35:56",
"upload_time_iso_8601": "2025-10-18T17:35:56.749384Z",
"url": "https://files.pythonhosted.org/packages/eb/f6/3668c88755b172d40eefbaf1a7e670d9ad07c1defb4b8d1a82956d3df205/incaricli-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-18 17:35:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "paolobtl",
"github_project": "incaricli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "incaricli"
}
JSON
