@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
1@title Arcanist User Guide: Windows
2@group userguide
3
4Explains how to install Arcanist on Windows.
5
6= Overview =
7
8Arcanist runs on Windows, either in `cmd.exe` or the Git Bash environments.
9However, it will take a little effort to get working. This document explains
10what you need to do in order to get it running.
11
12NOTE: Windows support is incomplete, file bugs when you run into issues.
13
14= Required Components =
15
16You need to install:
17
18 - Arcanist itself, see @{article:Arcanist User Guide}.
19 or @{article:Arcanist Quick Start}.
20 - PHP (see "Detailed PHP Install Instructions" below).
21 - Git, SVN, or Mercurial.
22
23Then, 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
33You can set environmental variables somewhere in the `Advanced` tab of the
34`System` control panel.
35
36Now you should be able to run `arc` normally (either from `cmd.exe` or
37Git Bash) and it should work more-or-less properly.
38
39= Configuring an Editor =
40
41NOTE: You **can not** use Notepad as your editor, because it does not have a
42blocking mode. You can use GitPad instead.
43
44Some arc workflows prompt you to edit large blocks of text using a text editor.
45You can configure various programs for this purpose, depending on which text
46editor you prefer. Some editors that will work are:
47
48 - [[ https://notepad-plus-plus.org/ | Notepad++ ]], a good all-around editor.
49 - **vim**, which comes with Git Bash.
50 - [[ https://www.sublimetext.com/ | Sublime Text ]].
51
52Other editors may also work, but they must have a blocking edit mode.
53
54To configure an editor, either set the `EDITOR` environmental variable to point
55at it, or run:
56
57 $ arc set-config editor "\"C:\path\to\some\editor.exe\""
58
59NOTE: Note the use of quotes. Paths with spaces in them must be quoted, and
60these quotes must be escaped when passed to `arc set-config`, as in the examples
61below.
62
63Specifically, you can use this command for **Notepad++** (adjusting the path for
64your machine):
65
66 name=Notepad++
67 $ arc set-config editor "\"C:\Program Files (x86)\Notepad++\notepad++.exe\" -multiInst -nosession"
68
69And this command for Vim (you may need to adjust the path):
70
71 name=vim
72 $ arc set-config editor "\"C:\Program Files (x86)\Git\share\vim\vim91\vim.exe\""
73
74And this for Sublime Text (you may need to adjust the path):
75
76 name=Sublime Text
77 $ arc set-config editor "\"C:\Program Files\Sublime Text 4\sublime_text.exe\" -w -n"
78
79= Detailed PHP Install Instructions =
80
81While multiple versions of PHP should work, you can follow these specific
82instructions if you're having trouble.
83
84 - Download the latest stable PHP binary release from:
85 <https://windows.php.net/download/>.
86 - Copy `php.ini-development` to `php.ini` in that same directory.
87 - Open `php.ini` and locate the line `;extension=php_curl.dll`. Remove the
88 `;` to activate this extension. Locate the line `; extension_dir = "ext"`
89 and change it to `extension_dir = "C:\PHP\ext"`, where `C:\PHP` is
90 the directory where you installed PHP.
91 - Verify that things work by running `php -i` from your commandline and
92 looking for `curl` in the output.
93
94= Next Steps =
95
96Continue by:
97
98 - returning to @{article:Arcanist User Guide}.