Skip to content

Commit

Permalink
testing cli
Browse files Browse the repository at this point in the history
  • Loading branch information
Zwiterrion committed Dec 6, 2023
1 parent 11a2f33 commit 4ecdeb6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 73 deletions.
8 changes: 4 additions & 4 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ with wasm modules:
# Quick start

```
wasmo init --name=my-first-plugin --templates=js
wasmo init --name=my-first-plugin --template=js
wasmo build --host=OneShotDocker --path=my-first-plugin
```

Expand All @@ -70,7 +70,7 @@ You can now optionally start a new plugin from a template by appending `--templa
If you don't pass a template, Wasmo will list the available templates: `js`, `ts`, `opa`, `go` and `rust`.

```
wasmo init --name=my-first-plugin --templates=[template-name] --path=[output-directory]
wasmo init --name=my-first-plugin --template=[template-name] --path=[output-directory]
```

Running this command with any of theses templates will create a directory called `my-first-plugin` inside the specified output directory (or the current if omitted). Inside that directory, it will generate the initial project structure with the metadata file pre-filled with the name of your plugin.
Expand All @@ -90,8 +90,8 @@ Assuming we want to build our `my-first-plugin` locally. Enter `wasmo build --ho
Let's explain these 3 parameters:
- the `path` parameter is explicitly used to indicate the plugin to build
- the `host` indicates which kind of Wasmo server used. The pratical way is to use `Docker` or `OneShotDocker` because it prevents to install a Wasmo server by deploying, inside your locally Docker, a new Wasmo container. The last possible value is `Remote` and can be used to specify with a URI the remote Wasmo server used.

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/NdbQR6vQ5Sk/0.jpg)](https://www.youtube.com/watch?v=NdbQR6vQ5Sk)
<!--
[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/NdbQR6vQ5Sk/0.jpg)](https://www.youtube.com/watch?v=NdbQR6vQ5Sk) -->

## Configure your configuration file

Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/app/cli/getting-started/_page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $ wasmo help
# Quick start

```
wasmo init --name=my-first-plugin --templates=js
wasmo init --name=my-first-plugin --template=js
wasmo build --host=OneShotDocker --path=my-first-plugin
```

Expand All @@ -46,7 +46,7 @@ You can now optionally start a new plugin from a template by appending `--templa
If you don't pass a template, Wasmo will list the available templates: `js`, `ts`, `opa`, `go` and `rust`.

```
wasmo init --name=my-first-plugin --templates=[template-name] --path=[output-directory]
wasmo init --name=my-first-plugin --template=[template-name] --path=[output-directory]
```

Running this command with any of theses templates will create a directory called `my-first-plugin` inside the specified output directory (or the current if omitted). Inside that directory, it will generate the initial project structure with the metadata file pre-filled with the name of your plugin.
Expand Down
69 changes: 2 additions & 67 deletions ui/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4ecdeb6

Please sign in to comment.