SeamFramework.orgCommunity Documentation

Chapter 1. Installation

1.1. Installing a distribution download

Installing Forge is a relatively short process, and this guide will take you through the fundamentals (providing links to external materials if required;) however, if you encounter any issues with this process, please ask in the Forge Users mailing list, or if you think something is wrong with this guide, report a defect under "Documentation".

If you would like to get involved, stop by the Forge Dev mailing list, file an issue, or come find us on irc.freenode.net, in channel #seam-dev.

Follow these steps to install a Forge distribution:

  1. Ensure that you have already installed a Java 6+ JDK.
  2. Download and Un-zip Forge (or a recent snapshot build) into a folder on your hard-disk, this folder will be your FORGE_HOME
  3. Add '$FORGE_HOME/bin' to your path (windows, linux, mac osx)
  4. Consider installing Git and Maven 3.0+ (both optional)
  5. Open a command prompt and run 'forge'
    localhost:~ $ forge      
    [no project] ~ $

That's it, you've now got Forge installed, but what to do next?

Tip

Having problems? Tell us.

There are a few things you should probably check-out. If you are confused at any time, try pressing <TAB>. For instance, if you have not yet seen the Forge built-in commands, you may either press <TAB> to see a list of the currently available commands, or get a more descriptive list by typing:

$ list-commands --all

You may also use the 'help' command for more detailed information about available Forge, a plugin, or a command.

$ help {plugin-name} {command-name}