aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Mark <[email protected]>2021-02-02 16:04:32 -0800
committerGravatar GitHub <[email protected]>2021-02-02 16:04:32 -0800
commitc580809b4147ee10384956bd3c0f8f082c87a426 (patch)
tree7262a361a59d2b4ac8174f5827fc8bd8aeb196b2 /README.md
parentRemove trailing whitespaces from the README (diff)
parentFix typo in error message (diff)
Merge PR #88 - use protobuf to parse config
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index bece28c..7e66c47 100644
--- a/README.md
+++ b/README.md
@@ -154,13 +154,13 @@ pipenv run devsh [--build [--clean]] [bash_args ...]
#### Invoking NsJail
-A shell alias named `nsjpy` is included and is basically `nsjail python -c <args>` but NsJail is configured as it would be if snekbox invoked it (such as the time and memory limits). It provides an easy way to run Python code inside NsJail without the need to run snekbox with its webserver and send HTTP requests. Example usage:
+NsJail can be invoked in a more direct manner that does not require using a web server or its API. See `python -m snekbox --help`. Example usage:
```bash
-nsjpy "print('hello world!')"
+python -m snekbox 'print("hello world!")' --time_limit 0
```
-The alias can be found in `./scripts/.profile`, which is automatically added when the shell is launched in the container.
+With this command, NsJail uses the same configuration normally used through the web API. It also has an alias, `pipenv run eval`.
[1]: https://github.com/python-discord/snekbox/workflows/Lint,%20Test,%20Build,%20Push/badge.svg?branch=master
[2]: https://github.com/python-discord/snekbox/actions?query=workflow%3A%22Lint%2C+Test%2C+Build%2C+Push%22+branch%3Amaster