Skip to content

Commit

Permalink
docs: README update with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
c-x committed Jul 3, 2024
1 parent fac158c commit 02d1714
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,54 @@ With LogCraft CLI, you can easily deploy your security detections into your SIEM

- [Splunk](./splunk)
- [Microsoft Azure Sentinel](./sentinel)

## Getting the bits

### Releases

[Download the latest build](https://github.com/LogCraftIO/logcraft-cli-plugins/releases) of the desired plugins directly from the releases page. This is the recommended approach for most users.

### Building from the sources

If you prefer, you can build the plugins from the sources:

First, clone the repository:

```bash
git clone https://github.com/LogCraftIO/logcraft-cli-plugins
cd logcraft-cli-plugins
```

Then, enter the directory of the plugin of your choice

```bash
cd <PLUGIN_DIR>
cargo component build --release
```

For example
```bash
cd splunk
cargo component build --release
```

The plugin will be released under: `../target/wasm32-wasi/release/` as a `.wasm` file.

Add it to `lgc` using the `plugins install` command:

```bash
~$ cd your-work-dir
~$ lgc plugins install /path/to/target/wasm32-wasi/release/<PLUGIN>.wasm
```
For example:

```bash
~$ lgc plugins install /path/to/target/wasm32-wasi/release/splunk.wasm
```

Note that compiling the plugin requires `cargo-component` and `wasm32-wasi`:

```bash
cargo install cargo-component --locked
rustup target add wasm32-wasi
```

0 comments on commit 02d1714

Please sign in to comment.