Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
greggman committed Nov 6, 2019
1 parent 41f49c5 commit 4976146
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,50 @@ having to install multiple dependencies nor having to integrate
things with their system. No adding to paths, no downloading
3 different pieces of software. Just run and start.

## Command Line Arguments

If you want an actual command line version then [go here](https://github.com/greggman/servez).

Otherwise these are the command line arguments to this app version
of Servez.

**NOTE! You must include a `--` before your arguments**

```
servez.exe --port=1234 c:\path\to\serve # BAD!
servez.exe -- --port=1234 c:\path\to\serve # good
```

On Windows the default path is

```
c:\Users\<username>\AppData\Local\Programs\Servez\Servez.exe
```

on MacOS the default path is

```
/Applications/Servez.app/Contents/MacOS/Servez
```

### Usage

```
servez [options] path/to/serve
```

* `--help` prints the command line arguments

* `-p` or `--port` sets the port as in `--port=1234`

* `--no-dirs` don't show directory listings for folders

* `--no-cors` don't supply CORS headers

* `--local` only allow access from local machine

* `--no-index` don't serve index.html for folders

## Development

### Setup
Expand Down

0 comments on commit 4976146

Please sign in to comment.