Appearance

Quickstart Checklist ​

This page is for people new to the Sprocket project who want to understand how to adopt it on their own project. Work through the items below to get your development environment, CI pipeline, and workflow execution set up.

Development environment ​

  • [ ] Install Sprocket. Get the sprocket CLI on your machine via Homebrew, direct download, or from source. See the Installation page.

  • [ ] Set up your editor. Install the VSCode extension or the Neovim plugin for inline diagnostics and syntax highlighting. See the VSCode guide for details.

  • [ ] Generate shell completions. Enable tab completion for commands and arguments in your shell. See Shell completions.

Code quality ​

  • [ ] Lint your WDL documents. Run sprocket lint to catch validation errors and style issues early. See the Guided Tour for a walkthrough.

  • [ ] Format your WDL documents. Run sprocket format overwrite to maintain consistent style across your project. See the format command reference.

  • [ ] Add the GitHub Action. Add the Sprocket GitHub Action to your CI pipeline so that linting and formatting are checked on every pull request.

Running workflows ​

  • [ ] Run your first workflow. Execute a task or workflow with sprocket run. The Guided Tour walks through a complete example.

  • [ ] Configure an execution backend. If you are running on an HPC cluster or a TES endpoint, configure a backend in your sprocket.toml. See the Execution Backends overview.

Community ​

  • [ ] Join the conversation. The #sprocket channel on the OpenWDL Slack is the best place for questions, feedback, and discussion.