src/docs/user/userguide/arcanist_quick_start.diviner

   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. For detailed instructions on
   8 installing Arcanist, see @{article:Arcanist User Guide}. OS specific guides
   9 are 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
  16 First, install dependencies:
  17
  18   - Install PHP.
  19   - Install Git.
  20
  21 Then install Arcanist itself:
  22
  23   somewhere/ $ git clone https://github.com/phacility/arcanist.git
  24
  25 Add `arc` to your path:
  26
  27   $ export PATH="$PATH:/somewhere/arcanist/bin/"
  28
  29 This won't work for Windows, see @{article:Arcanist User Guide: Windows} for
  30 instructions.
  31
  32 = Configure Your Project =
  33
  34 For detailed instructions on project configuration, see
  35 @{article:Arcanist User Guide: Configuring a New Project}.
  36
  37 Create 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://phabricator.example.com/"
  44   }
  45
  46 Set `phabricator.uri` to the URI for your Phabricator install (where `arc`
  47 should send changes to).
  48
  49 NOTE: You should **commit this file** to the repository.
  50
  51 = Install Arcanist Credentials =
  52
  53 Credentials allow you to authenticate. You must have an account on Phabricator
  54 before you can perform this step.
  55
  56   $ cd yourproject/
  57   yourproject/ $ arc install-certificate
  58   ...
  59
  60 Follow the instructions. This will link your user account on your local machine
  61 to your Phabricator account.
  62
  63 = Send Changes For Review =
  64
  65 For 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
  73 Continue 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}.