{"id":24055809,"url":"https://github.com/theonlyamos/runit","last_synced_at":"2026-02-14T00:14:36.005Z","repository":{"id":38829637,"uuid":"491700519","full_name":"theonlyamos/runit","owner":"theonlyamos","description":"A terminal client for creating and running serverless functions","archived":false,"fork":false,"pushed_at":"2024-05-05T10:29:27.000Z","size":4633,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-19T00:03:18.617Z","etag":null,"topics":["cloud","serverless"],"latest_commit_sha":null,"homepage":"","language":"Python","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/theonlyamos.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":"2022-05-12T23:50:23.000Z","updated_at":"2024-06-10T21:55:34.459Z","dependencies_parsed_at":"2023-11-12T12:32:07.522Z","dependency_job_id":"33b53d5c-f2f0-4aef-b074-59c5bcb477a7","html_url":"https://github.com/theonlyamos/runit","commit_stats":{"total_commits":77,"total_committers":3,"mean_commits":"25.666666666666668","dds":"0.23376623376623373","last_synced_commit":"27b78cfc14ff4a9d821375174c65667962217f40"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonlyamos%2Frunit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonlyamos%2Frunit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonlyamos%2Frunit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonlyamos%2Frunit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theonlyamos","download_url":"https://codeload.github.com/theonlyamos/runit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240841653,"owners_count":19866426,"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":["cloud","serverless"],"created_at":"2025-01-09T04:31:08.234Z","updated_at":"2026-02-14T00:14:35.969Z","avatar_url":"https://github.com/theonlyamos.png","language":"Python","readme":"# Runit CLI ![Python](https://img.shields.io/badge/builthwith-python-brightgreen) \nThe Runit Command Line Interface (CLI) Tools can be used to test, manage, and deploy your Runit project from the command line.\n- Create new runit project\n- Run a local web server for your runit project\n- publish code and assets to your runit-server domain\n- Interact with data in your runit-server database\n\n\n## Supported Languages\n![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge\u0026logo=python\u0026logoColor=ffdd54) ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge\u0026logo=javascript\u0026logoColor=%23F7DF1E) ![PHP](https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge\u0026logo=php\u0026logoColor=white)\n\n## Installation\n### Python Package\nYou can install the Runit CLI using pip (Python package manager). Note that you will need to install [Python](https://python.org).\nTo download and install the runit CLI run the following command:\n```shell\npip install runit\n```\nThis will provide you with the globally accessible ```runit``` command.\n\n### Install from source\n```shell\ngit clone https://github.com/theonlyamos/runit.git\ncd runit\npip install .\n```\n\n## Usage\nRun the below command to print out usage message.\n```shell\nrunit --help\n```\n![Runit Cli](https://awesomescreenshot.s3.amazonaws.com/image/3778408/34500895-ad63d3ceaef8002f59fc5fd499797ca5.png?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAJSCJQ2NM3XLFPVKA%2F20221117%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-Date=20221117T180652Z\u0026X-Amz-Expires=28800\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=afd652759d272e68a62fb9959ce4e86647af5d6269991c012c9e753bf22ef534)\n\n**Create New Project**\nRun the following in the command line to create a new runit project.\n\u003e Supported languages include: [Python](), [Javascript](), [PHP]()\n```shell\nrunit new \u003cproject-name\u003e --language \u003clangugage\u003e\n```\nRun ```runit new --help``` for all options\n\n**Run project locally**\n***Access functions on local server****\nRunning the command ```runit``` in a project directory spins up a local webserver which can be used to access the funtions in project.\n```shell\ncd \u003cproject-directory\u003e\nrunit\n```\nPoint your browser to the address provided followed by the function name to access that function.\n```http://localhost:5000/``` will be the default address.\nVisiting ```http://localhost:5000/hello_world``` will run the ```hello_world``` function in the project.\n\n***Run function and print output to shell***\nOutput function result to shell. Required arguments include:\n\u003e ```--function \u003cfunction_name\u003e```: Function name to call\n\u003e ```--shell```: sets shell output to true\n\u003e [Optional] ```--arguments|-x```: Arguments for the function if required. Can be called multiple times for multiple arguments\n\n```shell\ncd \u003cproject-directory\u003e\nrunit --function \u003chello_world\u003e --shell\n```\n\n### Publishing Project\nBefore you can publish any of your projects, you must setup the backend for your runit. You must also be logged in.\n\n**Setup Backend Details**\nThe backend must be running ***[runit-server](https://github.com/theonlyamos/runit-server)***.\nRun ```runit setup --help``` for help message.\n***Follow the prompts to complete the setup after running the below comman.***\n```shell\nrunit setup\n```\n\n**Account Login**\n```shell\nrunit login --help\n```\n```shell\nrunit login --email \u003cemail@example.org\u003e --password \u003csupersecretpass\u003e\n```\n**or**\n***Follow the commands after running below command***\n```shell\nrunit login\n```\n\n**Deploy/Publish Project**\n```shell\ncd \u003cproject-directory\u003e\nrunit publish\n```\n\n## License\n![License](https://img.shields.io/badge/LICENSE-MIT-brightgreen/?style=flat-square)\n\n**Free Software, Hell Yeah!**\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheonlyamos%2Frunit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheonlyamos%2Frunit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheonlyamos%2Frunit/lists"}