Skip to content

Commit

Permalink
chore: add nix run command to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
o-az committed Nov 25, 2024
1 parent 2eedac9 commit 6b2b291
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,51 @@
# Union Development Tools

> [!NOTE]
> The project is under active development. Everything is subject to change.
### Launch `openvscode-server` editor
# Union Development Tools

Launch Open VSCode with all the tools and extensions you need to ship.

```sh
nix run github:unionlabs/tools#ucode
```

pass `--help` flag to see all the options

```sh
nix run github:unionlabs/tools#ucode -- --help
```

```md
Quintessential development environment - powered by Open VSCode & VSX

Usage: launcher [OPTIONS]

Options:
--port <VALUE> Port to run the server on [default: 6699]
--host <VALUE> Host to run the server on [default: 127.0.0.1]
--path <VALUE> Repository to launch in VSCode [default: .]
--open Open the server in the browser
-h, --help Print help
-V, --version Print version
--open Open the server in the browser
-h, --help Print help
-V, --version Print version

Example:
launcher --path=/path/to/repo --port=6699 --host=localhost --open
```

For development:
### Passing arguments to `ucode`

```sh
cargo run --package=launcher --quiet -- \
--path="$(pwd)" \
--port=6699 \
--host=127.0.0.1 \
nix run github:unionlabs/tools#ucode -- \
--path='/absolute/path/to/repo' \
--port='6699' \
--host='127.0.0.1' \
--open
```

___

This flow is for early development. This will be packaged and used through nix. The end goal is the following with he same flags as above:
### Development

```sh
nix run github:unionlabs/tools#code --open
cargo run --package=launcher --quiet -- \
--path="$(pwd)" \
--port=6699 \
--host=127.0.0.1 \
--open
```

0 comments on commit 6b2b291

Please sign in to comment.