{"id":25720573,"url":"https://github.com/roysmanfo/flux","last_synced_at":"2026-06-13T03:04:41.206Z","repository":{"id":217755911,"uuid":"479823466","full_name":"roysmanfo/Flux","owner":"roysmanfo","description":"Flux is an open-source extensible and cross-platform Unix-like terminal written in python","archived":false,"fork":false,"pushed_at":"2026-06-04T18:23:42.000Z","size":1659,"stargazers_count":5,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-06-04T21:07:40.311Z","etag":null,"topics":["automation","python","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roysmanfo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-04-09T19:23:48.000Z","updated_at":"2026-06-04T18:23:17.000Z","dependencies_parsed_at":"2025-12-30T07:00:29.502Z","dependency_job_id":null,"html_url":"https://github.com/roysmanfo/Flux","commit_stats":null,"previous_names":["roysmanfo/flux"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/roysmanfo/Flux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roysmanfo%2FFlux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roysmanfo%2FFlux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roysmanfo%2FFlux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roysmanfo%2FFlux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roysmanfo","download_url":"https://codeload.github.com/roysmanfo/Flux/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roysmanfo%2FFlux/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34270418,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["automation","python","python3"],"created_at":"2025-02-25T17:51:02.619Z","updated_at":"2026-06-13T03:04:41.201Z","avatar_url":"https://github.com/roysmanfo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](./img/logo.svg)\n\nFlux is an extensible and cross-platform Unix-like terminal written in python that has many different commands built to help the user to manage many tasks.\n\n\n[![Unit Tests on dev branch](https://github.com/roysmanfo/Flux/actions/workflows/run-tests.yml/badge.svg?branch=dev)](https://github.com/roysmanfo/Flux/actions/workflows/run-tests.yml)\n\n\n# Installing Flux\n1. Clone the repository on your machine\n```sh\ngit clone https://github.com/roysmanfo/Flux.git\n```\n2. Install Flux using pip\n```sh\ncd Flux; pip install .\n```\n3. Verify that the installation has been successfull by running the `flux`\ncommand on your terminal\n\n## Develop your own commands\nFlux comes with many scripts for the most common tasks, but it also provides\nan API to develop your own scripts and commands.\n\nRead the docs regarding the [Flux API](./docs/api/flux_api.md).  \nYou can also find a guided tutorial on [how to create your first Flux command](./docs/api/first_command.md) \n\n## Develop Flux\nTo run Flux you will need to have python installed (at least version 3.8, but a version \u003e=3.10 is prefered)\n\n### setup (only the first time)\n\n**Linux**  \nIf you are using linux you can setup the system simply by executing `setup.sh`.  \nYou can decide to execute the commands manually, then here are the commands for setting up the system in both  and \n```sh\npip install virtualenv\npython3 -m venv --prompt venv .venv\nsource ./.venv/bin/activate\npip install -r linux-requirements.txt\n```\n**Windows**\n```bash\npip install virtualenv\npython -m venv --prompt venv .venv\n./.venv/Scripts/activate\npip install -r win-requirements.txt\n```\n\n### run\n\nto run Flux now you will need to move into the `Flux` folder\nand execute `main.py`\n\n\u003e   **NOTE**: Each time you will need to activate the virtual environment to execute `main.py`,\n\u003e   otherwise you will not have access to the dependencies you just installed \n    \n**Linux**\n```\ncd Flux \u0026\u0026 python3 main.py\n```\n**Windows**\n```\ncd Flux; python main.py\n```\n\n## Contributing\nIf you want to start contributing, you'll need a good knowledge of the python language, \nand feel confortable when using it.  \nYou'll also need do have some experience with __packages__ and __json__ files in python.  \nFore more information check [CONTRIBUTING.md](CONTRIBUTING.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froysmanfo%2Fflux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froysmanfo%2Fflux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froysmanfo%2Fflux/lists"}