Lib.rs

A flow-based runtime for WebAssembly components.
Explore the docs »

Install · Report Bug · Request Feature

About The Project

Wick is a low-code, flow-like runtime for stitching together WebAssembly components into full applications. Built With ❤️, Rust, and Wasm.

(back to top)

Getting Started

You'll need the wick binary to run Wick applications or invoke Wick components. You can install it with one of the following methods:

Installation

Pick your installation preference:

1. Cargo
2. Homebrew
3. Pre-built binaries
4. Install from source

Install with Cargo

cargo install wick-cli

(back to top)

Install with Homebrew

brew install candlecorp/tap/wick

(back to top)

Install pre-built binaries

Mac/Linux

curl -sSL sh.wick.run | bash

Windows

curl https://ps.wick.run -UseBasicParsing | Invoke-Expression

(back to top)

Install from source

git clone https://github.com/candlecorp/wick.git && cd wick
just deps # install necessary dependencies
just install # or cargo install --path crates/bins/wick

(back to top)

Usage

We're constantly adding examples to the ./examples directory which we also use as a base for our integration tests.

For more information, please refer to the Documentation

(back to top)

Roadmap

• HTTP Trigger
• Cron Trigger
• CLI Trigger
• WebAssembly Component-model support
• Expand automatic API generation
• WebSocket support
  • WebTransport as support improves

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Wick is distributed under the Elastic License 2.0 and Apache-2.0 licenses. See LICENSE for more information and individual crates for details.

(back to top)

Contact

Your Name - @candle_corp - jarrod@candle.dev

Project Link: https://github.com/candlecorp/wick

(back to top)