Download the PHP package mi-lopez/clockify-cli-wizard without Composer
On this page you can find all versions of the php package mi-lopez/clockify-cli-wizard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mi-lopez/clockify-cli-wizard
More information about mi-lopez/clockify-cli-wizard
Files in mi-lopez/clockify-cli-wizard
Package clockify-cli-wizard
Short Description A beautiful CLI wizard for time tracking with Clockify and Jira integration
License MIT
Informations about the package clockify-cli-wizard
π Clockify CLI Wizard
A beautiful, intelligent CLI wizard for seamless time tracking with Clockify and Jira integration.
Transform your time tracking workflow with smart automation, Git integration, and an intuitive command-line interface designed for developers β fully scriptable with a non-interactive JSON mode for AI agents.
β¨ Features
π€ Automation & AI Agents
- Non-interactive mode β every agent-facing command runs without prompts
- JSON output (
--json) for scripts and AI agents to parse --dry-runto preview writes without billing time- Discovery (
list) of projects/tasks/tags/workspaces/current as JSON - Jira β Clockify task mirroring for unattended, billable time tracking
π Smart Time Tracking
- Auto-detection from Git branch names (extracts ticket IDs like
CAM-451,PROJ-123) - Interactive wizard with intelligent suggestions
- Multiple time formats support (
2h,1h30m,90m,9:30am-11:30am) - Real-time timer with start/stop functionality
π― Jira Integration
- Automatic ticket fetching with summary and project info
- Project mapping between Jira and Clockify
- Recent issues selection for quick logging
- Task auto-creation with formatted names
π Advanced Reporting
- Daily/Weekly summaries with detailed breakdowns
- Timeline views with gap detection
- Export capabilities (CSV, JSON)
- Progress tracking against weekly targets
- Project and task analytics
π Timezone Intelligence
- Smart timezone handling (defaults to Chile/Santiago)
- Local time display with UTC API communication
- Working hours awareness
- International timezone support
π¨ Enhanced User Experience
- Beautiful CLI interface with colors and emojis
- Pagination and search for large project lists
- Progress indicators and status messages
- Configuration wizard with validation
- Error handling with helpful suggestions
π¦ Installation
Via Composer (Recommended)
Manual Installation
Add to PATH (Global Access)
βοΈ Configuration
Initial Setup
The wizard will guide you through:
-
Clockify API Setup
- API key (from app.clockify.me/manage-api-keys)
- Workspace selection
- User validation
-
Jira Integration (Optional)
- Jira URL (
https://company.atlassian.net) - Email address
- API token (from Atlassian API tokens)
- Jira URL (
- General Settings
- Timezone configuration
- Default duration settings
- Auto-detection preferences
Environment Variables (Optional)
π Quick Start
Basic Time Logging
Timer Management
Task Management
Reports and Analytics
π Available Commands
| Command | Description | Aliases |
|---|---|---|
configure |
Setup wizard for Clockify and Jira | config, setup |
start |
Start a timer for time tracking | begin |
stop |
Stop the active timer | end |
pause |
Pause the running timer (stop + remember) | |
resume |
Resume a paused timer | |
log |
Log time with smart detection | l |
today |
Show today's time summary | td |
week |
Show weekly time summary | wk |
create-task |
Create task from Jira ticket | task |
list |
List resources as JSON (agents/scripts) | |
list-tasks |
List tasks from projects (table) | tasks, ls |
map |
Map a Jira project key to a Clockify project | |
reports |
Generate detailed reports | report |
status |
Show current status and config | info |
π€ Non-interactive / AI agent mode
Every command an automation or AI agent needs can run without prompts and emit JSON, so the same Jira β Clockify workflow a human uses can be driven end-to-end by a script or agent.
How it activates:
- Pass
--json(recommended) β suppresses banners/prompts and prints a single JSON object to stdout. Errors are printed as{"error": "..."}with a non-zero exit code. - Or run under
--no-interaction(-n) β same non-interactive behavior with a minimal id on stdout. --dry-run(oncreate-task,start,log) shows what would be written without touching Clockify β a safety net against double-billing.
In non-interactive mode there are no prompts, so the Clockify project must be
resolvable from a --project flag or a saved JiraβClockify mapping (see
Project Mapping). Otherwise the command fails with a clear
message instead of hanging.
Discovery (list)
One-time mapping (map)
So unattended create-task/log/start can resolve the project automatically:
Two billing flows for agents
Both are supported β pick per situation:
--tags accepts a comma-separated list of labels and creates any that don't
exist yet.
Combined Jira β Clockify recipe
The PM/agent creates the Jira ticket, then mirrors it into Clockify so time can be billed against it:
--summary/--no-jira: by defaultcreate-taskfetches the summary from Jira to build the task name"KEY summary". When you already have the summary (e.g. straight from thejira-wizard createstep), pass--summary "<text>"to build the name locally and--no-jirato make zero Jira calls. This also matters when one Jira project maps to several Clockify projects (e.g. routed by epic): there is no 1-to-1 mapping that fits, so pass--projectexplicitly per ticket and keep the routing rule in your own runbook/skill.
π― Advanced Usage
Git Integration
The tool automatically detects ticket IDs from Git branch names:
Supported patterns:
feature/CAM-451-descriptionbugfix/PROJ-123CAM-451-hotfixTICKET-456
Project Mapping
Automatically map Jira projects to Clockify projects:
Time Format Examples
Smart Suggestions
The interactive mode provides intelligent suggestions:
- Recent Jira tickets for quick selection
- Time suggestions based on current time and common work hours
- Project suggestions based on Git context and history
π Reports and Analytics
Daily Summary
Shows:
- Total time tracked
- Project breakdown with percentages
- Timeline view with gaps
- Active timer status
Weekly Analysis
Features:
- Daily breakdown for the entire week
- Target progress (40-hour work week)
- Project distribution
- Export capabilities
Custom Reports
π§ Configuration Details
Config File Location
Sample Configuration
Reset Configuration
π Timezone Support
The tool intelligently handles timezones:
- Default:
America/Santiago(Chile) - Auto-detection from system settings
- Manual configuration during setup
- UTC conversion for API communication
- Local display for user interface
Supported Timezones
America/Santiago- Chile ContinentalPacific/Easter- Easter IslandUTC- Coordinated Universal TimeAmerica/New_York- Eastern TimeAmerica/Los_Angeles- Pacific TimeEurope/Madrid- Central European Time
π οΈ Development
Requirements
- PHP ^8.1
- Composer
- Git (for auto-detection features)
Local Development
Project Structure
π€ Contributing
We welcome contributions! Please read our Contributing Guide for details.
Development Workflow
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Add tests for new functionality
- Run the test suite (
composer test) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Reporting Issues
Please use the GitHub Issues page to report bugs or request features.
π Changelog
See CHANGELOG.md for version history and updates.
π Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Acknowledgments
- Clockify for the excellent time tracking API
- Atlassian for the Jira API
- Symfony Console for the CLI framework
- Carbon for date/time manipulation
- All contributors and users of this project
π¬ Support
- π Documentation: This README and inline help (
clockify-wizard --help) - π Bug Reports: GitHub Issues
- π‘ Feature Requests: GitHub Issues
- π§ Email: [email protected]
Made with β€οΈ for developers who value efficient time tracking
Features β’ Installation β’ Quick Start β’ Advanced Usage β’ Development
All versions of clockify-cli-wizard with dependencies
symfony/console Version ^6.0|^7.0
guzzlehttp/guzzle Version ^7.0
symfony/process Version ^6.0|^7.0
nesbot/carbon Version ^2.0|^3.0
league/csv Version ^9.0
symfony/filesystem Version ^6.0|^7.0
psr/log Version ^3.0