[Summary view] [Print] [Text view]

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