{"id":13452096,"url":"https://github.com/havardh/workflow","last_synced_at":"2025-04-07T12:08:59.857Z","repository":{"id":14270843,"uuid":"76202976","full_name":"havardh/workflow","owner":"havardh","description":"Workflow-centric workspace manager","archived":false,"fork":false,"pushed_at":"2022-12-10T17:03:34.000Z","size":8846,"stargazers_count":154,"open_issues_count":48,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-14T09:05:35.571Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/havardh.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-11T22:06:00.000Z","updated_at":"2024-05-20T11:09:48.000Z","dependencies_parsed_at":"2023-01-13T20:00:16.101Z","dependency_job_id":null,"html_url":"https://github.com/havardh/workflow","commit_stats":null,"previous_names":[],"tags_count":344,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/havardh%2Fworkflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/havardh%2Fworkflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/havardh%2Fworkflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/havardh%2Fworkflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/havardh","download_url":"https://codeload.github.com/havardh/workflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648978,"owners_count":20972945,"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-07-31T07:01:12.747Z","updated_at":"2025-04-07T12:08:59.831Z","avatar_url":"https://github.com/havardh.png","language":"JavaScript","readme":"# Workflow\n\n[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/workflow)\n\nAn experiment in declarative windows management with an optional [React](packages/workflow-react)\nfrontend and an experimental [Angular](packages/workflow-angular) frontend.\n\n## What does it do?\n\nWorkflow turns declarative windows layouts defined in javascript files ...\n\n```javascript\nexport const flow = render(\n  \u003cWorkspace name={'workflow-react-example'}\u003e\n    \u003cSplitH percent={1}\u003e\n      \u003cTextEditor percent={0.5} file={__filename} /\u003e\n      \u003cBrowser\n        percent={0.5}\n        url={'https://github.com/havardh/workflow/tree/master/packages/workflow-cmd'}\n      /\u003e\n    \u003c/SplitH\u003e\n  \u003c/Workspace\u003e,\n);\n```\n\n... into open applications populated with arguments in the specified layout on the screen.\n\n![](github/readme-example.png)\n\n## Usage\n\nWorkflow is a command line tool written for node.\n\nInstalling it globally with `npm` will set up the `workflow` command. On the first run, a home directory\nwill be set up. The default location is at `~/.workflow`. This is overridable with the ``WORKFLOW_HOME`\nenvironment variable. \n```bash\nnpm install --global workflow\n```\n\nRunning the command will by default resolve flow files relative to `~/.workflow/flows` or by\nan absolute path.\n```bash\nworkflow Example.js # resolves to ~/.workflow/flows/Example.js\nworkflow /path/to/file.js # resolves the file directly\n```\n\n## Cross platform\n\nWorkflow is written in a modular way to allow for extension. There are currently experimental support\nfor [osx](packages/workflow-wm-osx), [windows](packages/workflow-wm-windows), and linux using \n[i3](packages/workflow-wm-i3) or [wmctrl](packages/workflow-wm-wmctrl).\n\n## Devlopment\n\nThe [`cli.js`](packages/workflow/src/cli.js) can be executed in development mode. By default\nit will use the standard workflow-home directory, which is overridable by `WORKFLOW_DEV_HOME`.\nDevelopment mode is activated by setting the environment variable `WORKFLOW_DEV_MODE` to `true`.\nNote, you can set up an additional \u003cworkflow-home\u003e for dev with the create-workflow-home package.\n\n```bash\nyarn            # setup all dependencies\nyarn bootstrap  # bootstrap lerna\nyarn build      # run rollup to build all packages\n\nnode ./packages/create-workflow-home/cli.js \u003cworkflow-home-dev\u003e\nWORKFLOW_DEV_MODE=true WORKFLOW_DEV_HOME=\u003cworkflow-home-dev\u003e node ./packages/workflow/cli.js Example.js\n```\n\n## Contributions\n\nAll contributions to `workflow` are welcome. Checkout the [Contributions](contributions.md) guide to get started.\n\n## Code of conduct\n\nBy making a contribution to this project you agree to abide by the \n[Code of Conduct](code-of-conduct.md).\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhavardh%2Fworkflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhavardh%2Fworkflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhavardh%2Fworkflow/lists"}