[Summary view] [Print] [Text view]

   1  @title Arcanist User Guide: Windows
   2  @group userguide
   3  
   4  Explains how to install Arcanist on Windows.
   5  
   6  = Overview =
   7  
   8  Arcanist runs on Windows, either in `cmd.exe` or the Git Bash environments.
   9  However, it will take a little effort to get working. This document explains
  10  what you need to do in order to get it running.
  11  
  12  NOTE: Windows support is relatively new and incomplete, file bugs when you run
  13  into issues.
  14  
  15  = Required Components =
  16  
  17  You need to install:
  18  
  19    - Arcanist itself, see @{article:Arcanist User Guide}.
  20    - PHP (see "Detailed PHP Install Instructions" below).
  21    - SVN, Git, or Mercurial.
  22  
  23  Then, configure:
  24  
  25    - Your PATH environmental variable should include `arcanist/bin`, the `php`
  26      directory, and the directory where your VCS command lives. When you type
  27      `php`, `arc`, or (for example) `git` from the command line, they should all
  28      do something.
  29    - Your EDITOR environmental variable should point at some valid CLI editor,
  30      like the Git Bash `vim`. You can set this in `arc` if you prefer.
  31      See below for details.
  32  
  33  You can set environmental variables somewhere in the `Advanced` tab of the
  34  `System` control panel.
  35  
  36  Now you should be able to run `arc` normally (either from `cmd.exe` or
  37  Git Bash) and it should work more-or-less properly.
  38  
  39  = Configuring an Editor =
  40  
  41  NOTE: You **can not** use Notepad as your editor, because it does not have a
  42  blocking mode. You can use GitPad instead.
  43  
  44  Some arc workflows prompt you to edit large blocks of text using a text editor.
  45  You can configure various programs for this purpose, depending on which text
  46  editor you prefer. Some editors that will work are:
  47  
  48    - [[ http://notepad-plus-plus.org/ | Notepad++ ]], a good all-around editor.
  49    - **vim**, which comes with Git Bash.
  50    - [[ https://github.com/github/gitpad | GitPad ]], which allows you to use
  51      Notepad as your editor.
  52  
  53  Other editors may also work, but they must have a blocking edit mode.
  54  
  55  To configure an editor, either set the `EDITOR` environmental variable to point
  56  at it, or run:
  57  
  58    $ arc set-config editor "\"C:\path\to\some\editor.exe\""
  59  
  60  NOTE: Note the use of quotes. Paths with spaces in them must be quoted, and
  61  these quotes must be escaped when passed to `arc set-config`, as in the examples
  62  below.
  63  
  64  Specifically, you can use this command for **Notepad++** (adjusting the path for
  65  your machine):
  66  
  67    name=Notepad++
  68    $ arc set-config editor "\"C:\Program Files (x86)\Notepad++\notepad++.exe\" -multiInst -nosession"
  69  
  70  And this command for Vim (you may need to adjust the path):
  71  
  72    name=vim
  73    $ arc set-config editor "\"C:\Program Files (x86)\Git\share\vim\vim73\vim.exe\""
  74  
  75  And this for GitPad (you may need to adjust the path):
  76  
  77    name=GitPad
  78    $ arc set-config editor "\"C:\Users\yourusername\AppData\Roaming\GitPad\GitPad.exe\""
  79  
  80  And this for Sublime Text (you may need to adjust the path):
  81  
  82    name=Sublime Text
  83    $ arc set-config editor "\"C:\Program Files\Sublime Text 2\sublime_text.exe\" -w -n"
  84  
  85  = Detailed PHP Install Instructions =
  86  
  87  While multiple versions of PHP should work, you can follow these specific
  88  instructions if you're having trouble.
  89  
  90    - Download the latest stable PHP binary release from:
  91      <http://windows.php.net/download/>. When this document was last
  92      updated, this was PHP 5.4.6, but newer versions should also work. The
  93      "VC9 x86 Non Thread Safe" build should work correctly. (Other versions newer
  94      than PHP 5.3 should work, and thread-safe versions should also work.)
  95    - Unzip the PHP directory.
  96    - Copy `php.ini-development` to `php.ini` in that same directory.
  97    - Open `php.ini` and locate the line `;extension=php_curl.dll`. Remove the
  98      `;` to activate this extension. Locate the line `; extension_dir = "ext"`
  99      and change it to `extension_dir = "C:\PHP\ext"`, where `C:\PHP` is
 100      the directory where you installed PHP.
 101    - Verify that things work by running `php -i` from your commandline and
 102      looking for `curl` in the output.
 103  
 104  = Next Steps =
 105  
 106  Continue by:
 107  
 108    - returning to @{article:Arcanist User Guide}.