furk4ngg/keppler
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 Readme > Improve configuration part

Browse Source
This commit is contained in:
brunosimon
2017-09-20 23:17:07 +02:00
parent 6289c90a8d
commit 631e669e64
1 changed files with 58 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+58 -13
View File
@@ -1,6 +1,6 @@
# Keppler # Keppler
Real time code sharing for your lectures and presentations. > Real time code sharing for your lectures and presentations.
## What is keppler ## What is keppler
@@ -45,13 +45,13 @@ Simply share the URL that should appear with your audience and they will start r
## Configuration ## Configuration
You can add configuration argument when calling Keppler. You can add configuration arguments when calling Keppler.
``` ```
keppler "My project" --debug 0 --port 1234 --exclude "node_modules/**" --open true --test true --initial-send true --max-file-size 99999 keppler "My project" --debug 0 --port 1234 --exclude "node_modules/**" --open true --test true --initial-send true --max-file-size 99999
``` ```
or with shortcuts Same arguments using shortcuts
``` ```
keppler "My project" -d 0 -p 1234 -e "node_modules/**" -oti -m 99999 keppler "My project" -d 0 -p 1234 -e "node_modules/**" -oti -m 99999
@@ -59,16 +59,61 @@ keppler "My project" -d 0 -p 1234 -e "node_modules/**" -oti -m 99999
Arguments list Arguments list
|name|shortcut|default value|description| |||
|---|---|---|---| |---|---|
|<span style="white-space:nowrap">`--debug`</span>|`-d`|*(number)*`1`|Debug level<br>`0`: almost no log<br>`1`: primary logs<br>`2`: too much logs| |parameter|`--debug`|
|<span style="white-space:nowrap">`--name`</span>|`-n`|*(string)*`No name`|Project name<br>(you can simply add a string after `keppler` keyword like `keppler "My project"`)| |shortcut|`--d`|
|<span style="white-space:nowrap">`--port`</span>|`-p`|*(number)*`1571`|Server port| |default value|*(number)*`1`|
|<span style="white-space:nowrap">`--exclude`</span>|`-e`|*(string)*`**/.DS_Store,node_modules/**,vendor/**,.git`|Files to exclude| |description|Debug level<br>`0`: almost no log<br>`1`: primary logs<br>`2`: too much logs|
|<span style="white-space:nowrap">`--open`</span>|`-o`|*(bool)*`true`|Open in default browser|
|<span style="white-space:nowrap">`--test`</span>|`-t`|*(bool)*`false`|Start a test project with testing contents| |||
|<span style="white-space:nowrap">`--initial-send`</span>|`-i`|*(bool)*`false`|Send current files in the folder at start| |---|---|
|<span style="white-space:nowrap">`--max-file-size`</span>|`-m`|*(number)*`99999`|Maximum file size in octets| |parameter|`--name`|
|shortcut|`-n`|
|default value|*(string)*`No name`|
|description|Project name<br>(you can simply add a string after `keppler` keyword like `keppler "My project"`)|
|||
|---|---|
|parameter|`--port`|
|shortcut|`-p`|
|default value|*(number)*`1571`|
|description|Server port|
|||
|---|---|
|parameter|`--exclude`|
|shortcut|`-e`|
|default value|*(string)*`**/.DS_Store,node_modules/**,vendor/**,.git`|
|description|List of paths to exclude seperated with commas with wildcards support|
|||
|---|---|
|parameter|`--open`|
|shortcut|`-o`|
|default value|*(bool)*`true`|
|description|Open Keppler in default browser|
|||
|---|---|
|parameter|`--test`|
|shortcut|`-t`|
|default value|*(bool)*`false`|
|description|Start a test project with demo contents<br>:warning:Should not be used for a real presentation|
|||
|---|---|
|parameter|`--initial-send`|
|shortcut|`-i`|
|default value|*(bool)*`false`|
|description|Send current files in the folder at start<br>:warning:To much files may cause issues|
|||
|---|---|
|parameter|`--max-file-size`|
|shortcut|`-m`|
|default value|*(number)*`99999`|
|description|Maximum file size in octets<br>(99999 ≈ 100ko)|
## Features ## Features