# Runit CLI 
The Runit Command Line Interface (CLI) Tools can be used to test, manage, and deploy your Runit project from the command line.
- Create new runit project
- Run a local web server for your runit project
- publish code and assets to your runit-server domain
- Interact with data in your runit-server database
## Supported Languages
  
## Installation
### Python Package
You can install the Runit CLI using pip (Python package manager). Note that you will need to install [Python](https://python.org).
To download and install the runit CLI run the following command:
```shell
pip install runit
```
This will provide you with the globally accessible ```runit``` command.
### Install from source
```shell
git clone https://github.com/theonlyamos/runit.git
cd runit
pip install .
```
## Usage
Run the below command to print out usage message.
```shell
runit --help
```
**Create New Project**
Run the following in the command line to create a new runit project.
> Supported languages include: [Python](), [Javascript](), [PHP]()
```shell
runit new <project-name> --language <langugage>
```
Run ```runit new --help``` for all options
**Run project locally**
***Access functions on local server****
Running the command ```runit``` in a project directory spins up a local webserver which can be used to access the funtions in project.
```shell
cd <project-directory>
runit
```
Point your browser to the address provided followed by the function name to access that function.
```http://localhost:5000/``` will be the default address.
Visiting ```http://localhost:5000/hello_world``` will run the ```hello_world``` function in the project.
***Run function and print output to shell***
Output function result to shell. Required arguments include:
> ```--function <function_name>```: Function name to call
> ```--shell```: sets shell output to true
> [Optional] ```--arguments|-x```: Arguments for the function if required. Can be called multiple times for multiple arguments
```shell
cd <project-directory>
runit --function <hello_world> --shell
```
### Publishing Project
Before you can publish any of your projects, you must setup the backend for your runit. You must also be logged in.
**Setup Backend Details**
The backend must be running ***[runit-server](https://github.com/theonlyamos/runit-server)***.
Run ```runit setup --help``` for help message.
***Follow the prompts to complete the setup after running the below comman.***
```shell
runit setup
```
**Account Login**
```shell
runit login --help
```
```shell
runit login --email <email@example.org> --password <supersecretpass>
```
**or**
***Follow the commands after running below command***
```shell
runit login
```
**Deploy/Publish Project**
```shell
cd <project-directory>
runit publish
```
## License
**Free Software, Hell Yeah!**
Raw data
{
"_id": null,
"home_page": null,
"name": "runit-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python3 runit developer serverless architecture docker",
"author": "Amos Amissah",
"author_email": "theonlyamos@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bd/d1/bc794e9e74a17509d2774568ba743672afacaeb5691da02c77bdde18d214/runit_cli-0.4.0.tar.gz",
"platform": null,
"description": "# Runit CLI  \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  \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\n\n**Create New Project**\nRun the following in the command line to create a new runit project.\n> Supported languages include: [Python](), [Javascript](), [PHP]()\n```shell\nrunit new <project-name> --language <langugage>\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 <project-directory>\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> ```--function <function_name>```: Function name to call\n> ```--shell```: sets shell output to true\n> [Optional] ```--arguments|-x```: Arguments for the function if required. Can be called multiple times for multiple arguments\n\n```shell\ncd <project-directory>\nrunit --function <hello_world> --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 <email@example.org> --password <supersecretpass>\n```\n**or**\n***Follow the commands after running below command***\n```shell\nrunit login\n```\n\n**Deploy/Publish Project**\n```shell\ncd <project-directory>\nrunit publish\n```\n\n## License\n\n\n**Free Software, Hell Yeah!**\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Develop serverless applications",
"version": "0.4.0",
"project_urls": {
"Source": "https://github.com/theonlyamos/runit",
"Tracker": "https://github.com/theonlyamos/runit/issues"
},
"split_keywords": [
"python3",
"runit",
"developer",
"serverless",
"architecture",
"docker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "644ccf3b698da47397deea2c0594527513833be0045a9a0046e73ff2e13f91ff",
"md5": "960ac746cda18251c920b7ba49dcd7fe",
"sha256": "14db4c2aca84b76a9240a75cc07c17aa1a978d0b8683544b48211115cbdedfa2"
},
"downloads": -1,
"filename": "runit_cli-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "960ac746cda18251c920b7ba49dcd7fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38011,
"upload_time": "2024-04-13T14:28:42",
"upload_time_iso_8601": "2024-04-13T14:28:42.123594Z",
"url": "https://files.pythonhosted.org/packages/64/4c/cf3b698da47397deea2c0594527513833be0045a9a0046e73ff2e13f91ff/runit_cli-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bdd1bc794e9e74a17509d2774568ba743672afacaeb5691da02c77bdde18d214",
"md5": "435f3ae5cfcdd48d3ddba5ee1ca55f1d",
"sha256": "a0475db98f2b81dad8ad21cf7812f992cfb2faaf23cbe6624289ec266464a9de"
},
"downloads": -1,
"filename": "runit_cli-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "435f3ae5cfcdd48d3ddba5ee1ca55f1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31309,
"upload_time": "2024-04-13T14:28:43",
"upload_time_iso_8601": "2024-04-13T14:28:43.773249Z",
"url": "https://files.pythonhosted.org/packages/bd/d1/bc794e9e74a17509d2774568ba743672afacaeb5691da02c77bdde18d214/runit_cli-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 14:28:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "theonlyamos",
"github_project": "runit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "runit-cli"
}
JSON
