{"id":15724477,"url":"https://github.com/knuxify/workflow","last_synced_at":"2025-03-31T01:14:40.607Z","repository":{"id":139954365,"uuid":"214352674","full_name":"knuxify/workflow","owner":"knuxify","description":"Small bash application that loads scripts at a certain time","archived":false,"fork":false,"pushed_at":"2019-11-26T20:36:30.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T20:55:24.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/knuxify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-11T05:43:20.000Z","updated_at":"2022-10-27T15:00:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"397dc176-c98c-4159-b0f2-9c2cc7471ff2","html_url":"https://github.com/knuxify/workflow","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/knuxify%2Fworkflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knuxify%2Fworkflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knuxify%2Fworkflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knuxify%2Fworkflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/knuxify","download_url":"https://codeload.github.com/knuxify/workflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246399798,"owners_count":20770908,"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-10-03T22:16:47.665Z","updated_at":"2025-03-31T01:14:40.588Z","avatar_url":"https://github.com/knuxify.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# workflow - a small bash application that prevents you from procrastinating\n\n## Usage\n\nRun ``workflow-timer`` to automatically start workflow at certain times.\n\nYou can also run ``workflow`` manually (Usage: ``workflow \u003cmodules\u003e``).\n\nTo exit out of workflow, run ``workflow exit``.\n\n## How it works\n\nworkflow-timer runs in the background, waits for a certain hour (or until it's called manually) and, once activated, loads \"modules\" - small bash scripts with two functions: start and end.\nThe start function is called when workflow mode starts and the end function is called when workflow mode ends.\n\n## Installing\n\nCopy the workflow and workflow-timer files to /usr/bin, then run on workflow-timer on startup (reffer to your environment's documentation)\n\nAlternatively, you can just call the workflow command from a cron job.\n\n## Initial setup\n\nIn order to use workflow, you'll need to add modules to it. A good place to start would be picking something the sample-modules folder. In order to add a module, copy it to the ``$HOME/.config/workflow`` folder, then add the module name with the full path to ``$HOME/.config/workflow/modules``, separating the module name and full path by a space (see Modules in the Configuration section below).\n\nThen, follow the configuration guide for the workflow timer.\n\nFinally, run workflow-timer on startup as your user.\n\n## Configuration\n\n### Workflow timer\n\nThe workflow-timer is a script that runs in the background. It automatically starts workflow with certain modules (see section titled Modules below).\n\nIn order to start workflow automatically at a certain hour, add the following to the config file located at $HOME/.config/workflow/startup-time:\n\n```\nHH:MM W\n```\n\nWhere HH is the hour in a 24-hour format (NOTE: If an hour is single-digit, prepend 0 to it, for example 2:10 becomes 02:10), MM is the minute and W is a number corresponding to the day of the week (where 1 is Monday and 7 is Sunday).\n\nIn order to run workflow on multiple days of the week, set W to BEGGININGDAY-ENDDAY, for example 1-5 is going to run from Mondays to Fridays. You can also set W to 0 to run workflow every day.\n\nIn order to run workflow between certain hours, separate the two hours with a dash, like so:\n\n```\nHH:MM-HH:MM W\n```\n\nIn order to run certain modules at certain hour, you can provide them:\n\n```\nHH:MM W module1 module2 module3 ...\n```\n\nYou can also store multiple startup hours. Simply put them on new lines in the startup-time file.\n\n### Modules\n\nModules are shorthands for scripts that can be called by workflow.\n\nModules are defined in a configuration file: $HOME/.config/workflow/modules. This config location is also reccomended for storing modules. In order to create a module, add it to the module file like so:\n\n```\nmodulename \"/full/path/to/module\"\n```\n\nIn order to use a module, run workflow with the modules as arguments, separated by spaces. You can also place them in the $HOME/.config/workflow/modules.enabled file (although keep in mind that the arguments will take priority over this file).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknuxify%2Fworkflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknuxify%2Fworkflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknuxify%2Fworkflow/lists"}