Skip to content

Commit

Permalink
docs: add docs for --dev flag (#714)
Browse files Browse the repository at this point in the history
* docs: add docs for --dev flag

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
sansyrox and pre-commit-ci[bot] authored Dec 10, 2023
1 parent dcaca1f commit df9d1a1
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions docs_src/src/pages/documentation/api_reference/getting_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Batman was curious about how to run the application. Robyn explained that he cou
A robyn application exposes certain commands to the user. These commands can be used to run the application, or to generate a new project.

```bash
usage: app.py [-h] [--processes PROCESSES] [--workers WORKERS] [--dev] [--log-level LOG_LEVEL] [--create] [--docs] [--open-browser] [--version]
usage: app.py [-h] [--processes PROCESSES] [--workers WORKERS] [--log-level LOG_LEVEL] [--create] [--docs] [--open-browser] [--version]

Robyn, a fast async web framework with a rust runtime.

Expand All @@ -89,7 +89,6 @@ options:
--processes PROCESSES
Choose the number of processes. [Default: 1]
--workers WORKERS Choose the number of workers. [Default: 1]
--dev Development mode. It restarts the server based on file changes.
--log-level LOG_LEVEL
Set the log level name
--open-browser Open the browser on successful start.
Expand All @@ -98,7 +97,33 @@ options:
--create Create a new project template.
--docs Open the Robyn documentation.
--version Show the Robyn version.
--dev Development mode. It restarts the server based on file changes.

```

Or the application can be run using Robyn's CLI, i.e. using `python -m robyn app.py`

```bash

usage: python -m robyn app.py [-h] [--processes PROCESSES] [--workers WORKERS] [--dev] [--log-level LOG_LEVEL] [--create] [--docs] [--open-browser] [--version]


Robyn, a fast async web framework with a rust runtime.

options:
-h, --help show this help message and exit
--processes PROCESSES
Choose the number of processes. [Default: 1]
--workers WORKERS Choose the number of workers. [Default: 1]
--log-level LOG_LEVEL
Set the log level name
--open-browser Open the browser on successful start.

Module flags
--create Create a new project template.
--docs Open the Robyn documentation.
--version Show the Robyn version.
--dev Development mode. It restarts the server based on file changes.
```

---
Expand Down

0 comments on commit df9d1a1

Please sign in to comment.