{"id":18468183,"url":"https://github.com/tomchinery/toggl-forecaster-cli","last_synced_at":"2025-05-06T16:35:27.297Z","repository":{"id":42829304,"uuid":"266030080","full_name":"tomchinery/toggl-forecaster-cli","owner":"tomchinery","description":"A CLI tool that generates a Toggl Plan project forecast using a Jira backlog and Timetastic holidays","archived":false,"fork":false,"pushed_at":"2023-01-06T06:39:02.000Z","size":1499,"stargazers_count":0,"open_issues_count":13,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-16T18:22:48.482Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomchinery.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-22T05:55:10.000Z","updated_at":"2020-05-27T08:24:29.000Z","dependencies_parsed_at":"2023-02-05T13:30:34.298Z","dependency_job_id":null,"html_url":"https://github.com/tomchinery/toggl-forecaster-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchinery%2Ftoggl-forecaster-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchinery%2Ftoggl-forecaster-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchinery%2Ftoggl-forecaster-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchinery%2Ftoggl-forecaster-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomchinery","download_url":"https://codeload.github.com/tomchinery/toggl-forecaster-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252721393,"owners_count":21793806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T10:05:18.368Z","updated_at":"2025-05-06T16:35:27.273Z","avatar_url":"https://github.com/tomchinery.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# # `@tomchinery/toggl-forecaster-cli`\n\n\u003e A CLI tool that generates a Toggl Plan project forecast using a Jira backlog and Timetastic holidays\n\n## Summary\n\nThis tool is a CLI that will create a new Toggl \"Plan\" based on your current Jira Backlog. \n\n*Note: due to the complexity of working out differences in start and end date the tool only supports creation of a new \"Plan\" and cannot update an existing \"Plan\".*\n\nIt will:\n\n### [MVP] Migrate Assigned Users to Segments\n- All assigned users are collected from the backlog\n- Checks if the \"plan\" contains a Segment for each user. If not it will create one.\n\n### [MVP] Migrate Versions, Epics, and Components to Tags:\n- All Versions are collected from the backlog\n- All Epics are collected from the backlog\n- All Components are collected from the backlog\n- Checks if the \"plan\" contains a Tag for each Version, Epic and Component. If not it will create one.\n\n### [MVP] Migrate Issues to Tasks\n- All issues are collected from the backlog in priority order and grouped by assignee\n- It will then process all the issues for an assignee generating:\n  - Start / End Dates from estimates in sequential order based on available work hours for a given day\n  - Associated Tags for the task\n  - Link to the Jira Issue within the Task description\n  - Subtasks added as ToDo's \n  \n### [MVP] Migrate Sprints to Milestones\n- Sprints are generated based on a bi-weekly cycle on a specific day\n\n### [MVP 1.1] Migrate Public Holidays to Milestones\n\n### [MVP 1.1] Migrate Team Holidays to Milestones\n\n### [MVP 1.1] Migrate Assignees to Users (max 5 for free plan teams)\n  \n## Installation\n\nInstall via npm:\n```bash\nnpm install -g @tomchinery/toggl-forecaster-cli\n```\n\nSet some environment variables:\n```bash\nexport TOGGL_CLIENT_ID=\u003cyour_client_id\u003e;\nexport TOGGL_CLIENT_SECRET=\u003cyour_client_secret\u003e;\nexport JIRA_CLIENT_ID=\u003cyour_client_id\u003e;\nexport JIRA_CLIENT_SECRET=\u003cyour_client_secret\u003e;\n```\n\nCreate a configuration file in your home directory:\n```bash\ntouch ~/.toggl-forecaster-config\n```\n\n## Configuration\n\n\nThe `.toggl-forecaster-config` file contains the following object:\n\n```typescript\n  toggl: {\n    username: string;\n    password: string;\n  },\n  jira: {\n    site: string;\n    project: string;\n  },\n  sprintStartEndDay: string;\n```\n\n##### Toggl\n**username**\n\n- Your Toggl Username\n\n**password**\n\n- Your Toggl Password\n\n##### CLI Specific\n\n**sprintStartEndDay**\n\n- The day your sprint starts\n\n## Jira Guidelines\n\n@TODO: Write up public Jira guidelines document\n\n- Do not estimate lower than 4 hours\n  - Product Managers don't need anything more granular than this\n- Use Versions, Epics, and Components\n  - Versions are for tracking your MVP's\n  - Epics are for tracking your specific Features\n  - Components are for tracking any areas that need team visibility or review\n- Assign every issue\n  - Without an owner it won't get done\n- Only estimate top-level stories, tasks, or defects\n  - anything more granular likely means your team will be inefficient / too much admin work\n\n## \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomchinery%2Ftoggl-forecaster-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomchinery%2Ftoggl-forecaster-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomchinery%2Ftoggl-forecaster-cli/lists"}