diff options
Diffstat (limited to 'installer/README.md')
-rw-r--r-- | installer/README.md | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/installer/README.md b/installer/README.md new file mode 100644 index 000000000..309364fbc --- /dev/null +++ b/installer/README.md @@ -0,0 +1,70 @@ +# deno_installer + +Install remote or local script as executables. + +```` +## Installation + +`installer` can be install using iteself: + +```sh +deno -A https://deno.land/std/installer/mod.ts deno_installer https://deno.land/std/installer/mod.ts -A +```` + +Installer uses `~/.deno/bin` to store installed scripts so make sure it's in `$PATH` + +``` +echo 'export PATH="$HOME/.deno/bin:$PATH"' >> ~/.bashrc # change this to your shell +``` + +## Usage + +Install script + +```sh +$ deno_installer file_server https://deno.land/std/http/file_server.ts --allow-net --allow-read +> Downloading: https://deno.land/std/http/file_server.ts +> +> ✅ Successfully installed file_server. + +# local script +$ deno_installer file_server ./deno_std/http/file_server.ts --allow-net --allow-read +> Looking for: /dev/deno_std/http/file_server.ts +> +> ✅ Successfully installed file_server. +``` + +Use installed script: + +```sh +$ file_server +HTTP server listening on http://0.0.0.0:4500/ +``` + +Update installed script + +```sh +$ deno_installer file_server https://deno.land/std/http/file_server.ts --allow-net --allow-read +> ⚠️ file_server is already installed, do you want to overwrite it? [yN] +> y +> +> Downloading: https://deno.land/std/http/file_server.ts +> +> ✅ Successfully installed file_server. +``` + +Show help + +```sh +$ deno_installer --help +> deno installer + Install remote or local script as executables. + +USAGE: + deno https://deno.land/std/installer/mod.ts EXE_NAME SCRIPT_URL [FLAGS...] + +ARGS: + EXE_NAME Name for executable + SCRIPT_URL Local or remote URL of script to install + [FLAGS...] List of flags for script, both Deno permission and script specific flag can be used. +``` |