About Wok
Wok helps to organize multiple git repositories into a single multi-project workspace.
Wok is a command line tool intended to be used alongside git in cases that require
multiple git repositories to be managed in connection with each other.
Wok utilizes git submodules to control several repositories and therefor requires
a separate parent (umbrella) repository.
Learn about Wok
- Why Wok? — about motivation behind creating
Wok - Wok Overview — a quick overview of
Wokmechanics - Quickstart — start to use
Wok - CLI Reference —
Wokcommand line interface reference
Install Wok
Pre-built binaries
🚧 TBD
Install using cargo
🚧 TBD
Build from source
- Install Rust
See https://www.rust-lang.org/learn/get-started.
- Clone Wok repository
git clone https://gitlab.com/wokdev/wok && cd ./wok
- Build Wok
cargo build --release
- Copy Wok executable to the location of your choice
cp ./target/release/wok /path/to/install/location
Contribute to Wok
Contributions in any form and in any amount from anyone are always welcome.
Wok is licensed under MIT License.
Please, read our contributing guide and Code of Conduct.
Resources
- wok.dev — Wok docs (this site)
- Wok on Gitlab — source code, pull requests, releases, issues, suggestions, getting help
- Wok on Github — source code, pull requests
- Code of Conduct — Contributor Covenant Code of Conduct (adapted from the Contributor Covenant)