This is a alpha project. Documentation and implementation may not be entirely in-sync.

liq is user-friendly development and process management framework. liq provides:

• clear project specification guidelines,
• a straightforward, well-defined development workflow
• extensible libraries of (mostly) automatically enforced change and submission policies, and
• built in CI/CD.

---

• Installation
• Basic usage
  • Setup
  • Doing work
  • Runtime management
• Policies
• CI/CD
• Supported platforms
• Contributions and bounties
• Further reading

Installation

npm inistall -g @liquid-labs/liq-cli

Basic usage

Setup

Setup your local environment. See Usage: Setup for details.

liq meta init
liq projects import @liquid-labs/liquid-cli # or whatever

Developing

Do work; make changes. See [Usage: Developing with liq](/docs/usage/Developing with liq.md) for details.

cd "$(liq projects dir @liquid-labs/liq-cli)"
# cd ~/playground/\@liquid-labs/liq-cli
liq work start -i 100 "adding golang support"
# make changes
liq work test
liq work qa
liq work save -am "golang support added"
liq work submit
liq work close

Runtime management

Manage your local development, test, and production environments. See [Usage: Runtime management](/docs/usage/Runtime management.md) for details.

liq environments create
liq data rebuild
liq services start

Policies

liq has built in support for (optional) development and organizational policies:

• Prebuilt policies libraries can be easily installed; Liquid Labs offers standard open source policies as well as PCI and SOC 2 compliant policies.
• All policies are fully cutomizable.
• Policies are subject to the same change controls as code.

See [Usage: Policy management](/docs/usage/Policy management.md) for details.

CI/CD

Liquid Projects offer greatly simplified (and entirely optional) integration with a full CI/CD process supporting:

• Built in CI/CD workflow best-practices.
• Fully automated static code analysis (for supported languages).
• Configurable automated or manual deploy.
• Automated project badging and trend reports.

Supported platforms

Support for target distros is currently limited. Full support for additional distros will be rolled out once we reach a stable beta.

• MacOS is the primary/lead platform.
• Some testing is done on Ubuntu.
• Most Linux or BSD based distros should work (perhaps with some tweaks).
• At this point, Windows is entirely out of scope, though in theory Windows with CygWin or similar may work.

Contributions and bounties

This project offers bounties on many issues.

• Search for available bounty tasks in this project or all Liquid Labs bounty tasks.
• Refer to [Contributions and Bounties](/docs/Contributions and Bounties.md).
• Claim a bounty!

Non-bounty contributions are also welcome. You may also refer to open, non-bountied issues and make an offer.

Further reading

For a more detailed look at liq, please refer to the project documentation.