@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 Quick Start
2@group userguide
3
4Quick guide to getting Arcanist working for a new project.
5
6This is a summary of steps to install Arcanist, configure a project for use with
7it, and run `arc` to send changes for review. For detailed instructions on
8installing Arcanist, see @{article:Arcanist User Guide}. OS specific guides
9are also available.
10
11 - For Mac OS X, see @{article:Arcanist User Guide: Mac OS X}.
12 - For Windows, see @{article:Arcanist User Guide: Windows}.
13
14= Installing Arcanist =
15
16First, install dependencies:
17
18 - Install PHP.
19 - Install Git.
20
21Then install Arcanist itself:
22
23 somewhere/ $ git clone https://github.com/phorgeit/arcanist.git
24
25Add `arc` to your path:
26
27 $ export PATH="$PATH:/somewhere/arcanist/bin/"
28
29This won't work for Windows, see @{article:Arcanist User Guide: Windows} for
30instructions.
31
32= Configure Your Project =
33
34For detailed instructions on project configuration, see
35@{article:Arcanist User Guide: Configuring a New Project}.
36
37Create a `.arcconfig` file in your project's working copy:
38
39 $ cd yourproject/
40 yourproject/ $ $EDITOR .arcconfig
41 yourproject/ $ cat .arcconfig
42 {
43 "phabricator.uri" : "https://phorge.example.com/"
44 }
45
46Set `phabricator.uri` to the URI for your Phorge install (where `arc`
47should send changes to).
48
49NOTE: You should **commit this file** to the repository.
50
51= Install Arcanist Credentials =
52
53Credentials allow you to authenticate. You must have an account on Phorge
54before you can perform this step.
55
56 $ cd yourproject/
57 yourproject/ $ arc install-certificate
58 ...
59
60Follow the instructions. This will link your user account on your local machine
61to your Phorge account.
62
63= Send Changes For Review =
64
65For detailed instructions on using `arc diff`, see
66@{article:Arcanist User Guide: arc diff}.
67
68 $ $EDITOR file.c
69 $ arc diff
70
71= Next Steps =
72
73Continue by:
74
75 - learning more about project configuration with
76 @{article:Arcanist User Guide: Configuring a New Project}; or
77 - learning more about `arc diff` with
78 @{article:Arcanist User Guide: arc diff}; or
79 - returning to @{article:Arcanist User Guide}.