Update README.md

This commit is contained in:
deepend-tildeclub 2023-08-02 15:02:20 -06:00 committed by GitHub
parent 84d3acf406
commit 5acab0fa24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions

View File

@ -1,19 +1,21 @@
# `tilde` - manage user-submitted scripts
forked from [tilde](https://tildegit.org/team/tilde-launcher)
adding in updates from [envs.net fork](https://git.envs.net/envs/envs_launcher/)
# `tilde` - user script tilde-launcher
```
wrapper for user-submitted scripts
supports user settings, submission and admin approval
Usage: tilde [options] [command]
User Scripts
Options:
-h, --help Show this help message and exit
-v, --version Show version information
usage: tilde [help|list|submit|about|script_name]
tilde list - show a list of approved userscripts
tilde submit - start the submission flow for your own script
tilde about <script_name> - get the description for script_name
tilde <script_name> - run script_name with all remaining args are passed to the script
Commands:
list Show a list of approved user scripts
submit Start the submission flow for your own script
about <script> Show description and details of a specific script
approve Enter the approval queue for pending scripts (requires root)
revoke <script> Revoke a previously approved script (requires root)
run <script> Run an approved script
Please add /tilde/bin to your PATH to use approved scripts without this wrapper.
```
approved scripts are placed in /tilde/bin and listed with `tilde list`
@ -21,4 +23,3 @@ approved scripts are placed in /tilde/bin and listed with `tilde list`
submissions use sendmail to notify an admin.
admins can use `sudo tilde approve` and `sudo tilde revoke <script_name>`.