-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ab115e1
commit d842ce8
Showing
2 changed files
with
110 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
title: SherpaJS CLI | ||
description: The SherpaJS CLI allows you to develop, build, start your application, and more. | ||
--- | ||
|
||
# SherpaJS CLI | ||
|
||
The SherpaJS command-line interface (CLI) allows you to develop, build, start your application, and | ||
more. | ||
|
||
|
||
<br/> | ||
|
||
|
||
## Installation | ||
To install the SherpaJS CLI, simply run the following command: | ||
|
||
```bash | ||
npm install sherpa-core -g | ||
``` | ||
|
||
This command will globally install the SherpaJS core package, enabling you to | ||
utilize its features across your system. Once installed, you can easily run | ||
the SherpaJS command-line interface (CLI) using the following command: | ||
|
||
```bash | ||
sherpa | ||
``` | ||
|
||
|
||
<br/> | ||
|
||
|
||
## Commands | ||
CLI for SherpaJS - Modular Microservices Framework | ||
|
||
```bash | ||
sherpa [options] [command] | ||
``` | ||
|
||
#### Options: | ||
- `-V`, `--version` output the version number | ||
- `-h`, `--help` display help for command | ||
|
||
#### Commands: | ||
- `build [options]` Build SherpaJS Server | ||
- `start [options]` Start SherpaJS Server Locally | ||
- `clean [options]` Remove SherpaJS Build Directories | ||
- `help [command]` display help for command | ||
|
||
|
||
<br/> | ||
|
||
|
||
### Build Command | ||
Build SherpaJS Server. | ||
```bash | ||
sherpa build [options] | ||
``` | ||
|
||
#### Options: | ||
- `-i`, `--input <path>` path to SherpaJS server, defaults to current directory | ||
- `-o`, `--output <path>` path to server output, defaults to input directory | ||
- `-b`, `--bundler <type>` platform bundler ("**Vercel**", "*local**", *default: "local"*) | ||
- `-v`, `--variable [key values...]` Specify optional environment variables as key=value pairs Ex. `foo=bar test="1234 HI"` | ||
- `--dev` enable development mode, does not minify output | ||
- `-h`, `--help` display help for command | ||
|
||
|
||
|
||
<br/> | ||
|
||
|
||
### Start Command | ||
Start SherpaJS Server Locally. Ensure you have created a [local build](/api/cli#build-command). | ||
```bash | ||
sherpa start [options] | ||
``` | ||
|
||
#### Options: | ||
- `-i`, `--input <path>` path to SherpaJS server, defaults to current directory | ||
- `-p`, `--port <number>` port number (default: "3000") | ||
- `-h`, `--help` display help for command | ||
|
||
|
||
<br/> | ||
|
||
|
||
### Clean Command | ||
Remove SherpaJS Build Directories. | ||
```bash | ||
sherpa clean [options] | ||
``` | ||
|
||
#### Options: | ||
- `-i`, `--input <path>` path to SherpaJS build directories, defaults to current directory | ||
- `-h`, `--help` display help for command | ||
|