/scalate-website/src/documentation/tool.page

http://github.com/scalate/scalate · Visualforce Page · 57 lines · 37 code · 20 blank · 0 comment · 0 complexity · a2cbb66f80965024a16d1e42b0371ae2 MD5 · raw file 

    

  1. ---
    2. 

  2. title: Scalate Tool
    3. 

  3. in_menu: false
    4. 

  4. sort_info: 5
    5. 

  5. --- name:overview
    6. 

  6. 

  7. # Scalate Tool
    8. 

  8. Scalate Tool helps get you scalate-ing faster!
    9. 

  9. 

  10. --- name:content pipeline:jade
    11. 

  11. 

  12. .right
    13. 

  13.   :&markdown
    14. 

  14.     Scatate Tool is a handy command line tool for working with Scalate. It provides various features such as
    15. 

  15. 

  16.     * [Creating new projects using Scalate](getting-started.html)
    17. 

  17.     * [Converting existing JSP files over to Scalate](jspConvert.html)
    18. 

  18.     * [Generating static websites](siteGen.html) 
    19. 

  19. 

  20. .left
    21. 

  21.   :markdown
    22. 

  22.     # Getting Started
    23. 

  23. 

  24. .right
    25. 

  25.   :&markdown
    26. 

  26.     Scalate Tool has the following requirements
    27. 

  27. 

  28.     * Scalate requires a [Java development kit](http://java.sun.com/) of version 1.5 or later
    29. 

  29. 

  30.     To get started with the Scalate Tool you'll need to download and [install](installing.html) it.
    31. 

    32. 

  32. .left
    33. 

  33.   :markdown
    34. 

  34.     # Using the Scalate Tool
    35. 

  35. 

  36. .right
    37. 

  37.   :markdown
    38. 

  38. 

  39.     Once you have installed the Scalate Tool via one of the above methods, you should be able to use the **scalate** executable on the command line.
    40. 

  40. 

  41.     The scalate tool supports a number of sub commands rather like **git** or **svn**. You can invoke a sub command directly such as
    42. 

  42. 

  43.         scalate run myTemplate.ssp
    44. 

  44. 

  45.     you can get a list of all the available sub commands via
    46. 

  46. 

  47.         scalate help
    48. 

  48. 

  49.     or to get help on a specific command you can type
    50. 

  50. 

  51.         scalate --help
    52. 

  52.     
    53. 

  53.     or enter the Scalate interactive shell via
    54. 

  54. 

  55.         scalate
    56. 

  56.     
    57. 

  57.     Once in the shell help will apppear to help guide you through the available commands. The shell supports tab completion rather like bash to help you execute the commands easily.
    58.