Getting Started

Getting started with Warpforge may still be a little bumpy -- we're a young project. But here's an outline of where you can start:

Simple Quickstart

• Install warpforge!
  • For now, this means git clone https://github.com/warptools/warpforge && cd warpforge && make install, and requires a go compiler and toolchain already installed.
  • You may also need to export PATH=$PATH:~/go/bin, as this is the location make install drops the binaries.
  • We tend to symlink or alias wf as a shorthand for warpforge, too. (If you don't do this, that's fine, but you might need to lengthen some of the commands you see in demos accordingly.)
• warpforge -h
  • This will show you all the subcommands, and basic help menu locally.
• warpforge quickstart
  • ... which will error ;) but hopefully inform you where to go from there.
• warpforge quickstart example.org/demo-proj
  • that's better ;)
• And from there, all these commands should do interesting and useful things (as described in the mesages from quickstart):
  • warpforge catalog update
  • warpforge status
  • warpforge run
  • (and more)
• If you have trouble getting things to work:
  • Try warpforge health to run some quick self-diagnostics!
  • Come to us in some of the Community channels and please ask for help!

More references

To see more complex examples of Warpforge usage, check out:

• the Demos page!
• the Warpsys Catalog!
  • as source modules in a workspace: github.com/warptools/warpsys
  • as released catalog info, in JSON in git: github.com/warptools/catalog
  • as released catalog info, in HTML-presented form: catalog.warpsys.org
• the examples directory in the project source repo!