wick-cli

A functional framework for WebAssembly components that run on the server and client.
Explore the docs »

Install · Report Bug · Request Feature

About The Project

Wick is a runtime for running and composing WebAssembly components together as full applications. Wick is built With ❤️, Rust, and Wasm.

(back to top)

Why Wick?

We built wick because we wanted a secure, fast, functional framework that used WebAssembly as its core component model. We wanted to build applications and libraries that could run on the server, client, and everywhere else. We needed it to be async first, streaming, and not rely on external systems. Suprisingly, nothing like this existed, so we built it.

Who should use Wick?

If you:

• Like functional programming ideas.
• Want to write code once and use it the same way everywhere.
• Like security baked into your applications.
• Have built enough software to recognize everyone is solving the same problems.
• Play on the bleeding edge of technology.

Then Wick is for you.

Demos/Examples

Online demos of Wick in action:

• Text generation
• Text redaction
• Object detection
• Resume Refining SAAS

Public repository of component examples:

• Wick Components

Wick's example directory:

• Wick examples

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 .

(back to top)

Usage

Wick's original WebAssembly component protocol uses RSocket to support complex, rich streams in WebAssembly.

Wick supports varying degrees of the standard WebAssembly component model and will continue to support more as the specification stabilizes.

To build a WebAssembly component

• Clone the template with cargo generate (or git clone)
• Build & sign it with just build
• Execute your new library component with wick invoke

$ cargo generate candlecorp/wick templates/rust --name my-project
$ cd my-project
$ just build
$ wick invoke component.wick greet -- --input="$USER"
{"payload":{"value":"Hello, jsoverson"},"port":"output"}

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)

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

@candle_corp - jarrod@candle.dev

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

(back to top)