.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ARC 1" .TH ARC 1 "2016-10-24" "" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" arc \- arcanist, a code review and revision management utility .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBarc\fR \fIcommand\fR [\fIoptions\fR] [\fIargs\fR] This help file provides a detailed command reference. .SH "COMMAND REFERENCE" .IX Header "COMMAND REFERENCE" \&\fBalias\fR .PP \&\fBalias\fR \fIcommand\fR .PP \&\fBalias\fR \fIcommand\fR \fItarget\fR \*(-- [\fIoptions\fR] .Sp .RS 4 Supports: cli Create an alias from \fIcommand\fR to \fItarget\fR (optionally, with \&\fIoptions\fR). For example: .Sp .Vb 1 \& arc alias fpatch patch \-\- \-\-force .Ve .Sp \&...will create a new 'arc' command, 'arc fpatch', which invokes \&'arc patch \-\-force ...' when run. \s-1NOTE:\s0 use \*(L"\-\-\*(R" before specifying options! .Sp If you start an alias with \*(L"!\*(R", the remainder of the alias will be invoked as a shell command. For example, if you want to implement \&'arc ls', you can do so like this: .Sp .Vb 1 \& arc alias ls \*(Aq!ls\*(Aq .Ve .Sp You can now run \*(L"arc ls\*(R" and it will behave like \*(L"ls\*(R". Of course, this example is silly and would make your life worse. .Sp You can not overwrite builtins, including 'alias' itself. The builtin will always execute, even if it was added after your alias. .Sp To remove an alias, run: .Sp .Vb 1 \& arc alias fpatch .Ve .Sp Without any arguments, 'arc alias' will list aliases. .RE .PP \&\fBamend\fR [\-\-revision \fIrevision_id\fR] [\-\-show] .Sp .RS 4 Supports: git, hg Amend the working copy, synchronizing the local commit message from Differential. .Sp Supported in Mercurial 2.2 and newer. .IP "\fI\-\-revision\fR \fIrevision_id\fR" 4 .IX Item "--revision revision_id" .RE .RS 4 .Sp .RS 4 Use the message from a specific revision. If you do not specify a revision, arc will guess which revision is in the working copy. .RE .RE .RS 4 .IP "\fI\-\-show\fR" 4 .IX Item "--show" .RE .RS 4 .Sp .RS 4 Show the amended commit message, without modifying the working copy. .RE .RE .RS 4 .RE .PP \&\fBanoid\fR .Sp .RS 4 There's only one way to find out... .RE .PP \&\fBbackout\fR .Sp .RS 4 Reverts/backouts on a previous commit. Supports: git, hg .Sp .RS 4 Command is used like this: arc backout | Entering a differential revision will only work if there is only one commit associated with the revision. This requires your working copy is up to date and that the commit exists in the working copy. .RE .RE .RS 4 .RE .PP \&\fBbookmark\fR [\fIoptions\fR] .PP \&\fBbookmark\fR \fIname\fR [\fIstart\fR] .Sp .RS 4 Supports: hg Alias for arc feature. .IP "\fI\-\-by\-status\fR" 4 .IX Item "--by-status" .RE .RS 4 .Sp .RS 4 Sort branches by status instead of time. .RE .RE .RS 4 .IP "\fI\-\-output\fR \fIformat\fR" 4 .IX Item "--output format" .RE .RS 4 .Sp .RS 4 With 'json', show features in machine-readable \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-view\-all\fR" 4 .IX Item "--view-all" .RE .RS 4 .Sp .RS 4 Include closed and abandoned revisions. .RE .RE .RS 4 .RE .PP \&\fBbranch\fR [\fIoptions\fR] .PP \&\fBbranch\fR \fIname\fR [\fIstart\fR] .Sp .RS 4 Supports: git Alias for arc feature. .IP "\fI\-\-by\-status\fR" 4 .IX Item "--by-status" .RE .RS 4 .Sp .RS 4 Sort branches by status instead of time. .RE .RE .RS 4 .IP "\fI\-\-output\fR \fIformat\fR" 4 .IX Item "--output format" .RE .RS 4 .Sp .RS 4 With 'json', show features in machine-readable \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-view\-all\fR" 4 .IX Item "--view-all" .RE .RS 4 .Sp .RS 4 Include closed and abandoned revisions. .RE .RE .RS 4 .RE .PP \&\fBbrowse\fR [\fIoptions\fR] \fIpath\fR ... .PP \&\fBbrowse\fR [\fIoptions\fR] \fIobject\fR ... .Sp .RS 4 Supports: git, hg, svn Open a file or object (like a task or revision) in your web browser. .Sp .Vb 3 \& $ arc browse README # Open a file in Diffusion. \& $ arc browse T123 # View a task. \& $ arc browse HEAD # View a symbolic commit. .Ve .Sp Set the 'browser' value using 'arc set\-config' to select a browser. If no browser is set, the command will try to guess which browser to use. .IP "\fI\-\-branch\fR \fIbranch_name\fR" 4 .IX Item "--branch branch_name" .RE .RS 4 .Sp .RS 4 Default branch name to view on server. Defaults to \*(L"master\*(R". .RE .RE .RS 4 .IP "\fI\-\-force\fR" 4 .IX Item "--force" .RE .RS 4 .Sp .RS 4 Open arguments as paths, even if they do not exist in the working copy. .RE .RE .RS 4 .RE .PP \&\fBcall-conduit\fR \fImethod\fR .Sp .RS 4 Supports: http, https Allows you to make a raw Conduit method call: .Sp .Vb 3 \& \- Run this command from a working directory. \& \- Call parameters are REQUIRED and read as a JSON blob from stdin. \& \- Results are written to stdout as a JSON blob. .Ve .Sp This workflow is primarily useful for writing scripts which integrate with Phabricator. Examples: .Sp .Vb 2 \& $ echo \*(Aq{}\*(Aq | arc call\-conduit conduit.ping \& $ echo \*(Aq{"phid":"PHID\-FILE\-xxxx"}\*(Aq | arc call\-conduit file.download .Ve .RE .PP \&\fBclose\fR \fItask_id\fR [\fIoptions\fR] Close a task or otherwise update its status. .IP "\fI\-\-list\-statuses\fR" 4 .IX Item "--list-statuses" .Sp .RS 4 Show available status options and exit. .RE .IP "\fI\-\-message\fR \fIcomment\fR, \fI\-m\fR \fIcomment\fR" 4 .IX Item "--message comment, -m comment" .Sp .RS 4 Provide a comment with your status change. .RE .IP "\fI\-\-status\fR \fIstatus\fR, \fI\-s\fR \fIstatus\fR" 4 .IX Item "--status status, -s status" .Sp .RS 4 Specify a new status. Valid status options can be seen with the `list\-statuses` argument. .RE .PP \&\fBclose-revision\fR [\fIoptions\fR] \fIrevision\fR .Sp .RS 4 Supports: git, hg, svn Close a revision which has been committed (svn) or pushed (git, hg). You should not normally need to do this: arc commit (svn), arc amend (git, hg), arc land (git, hg), or repository tracking on the master remote repository should do it for you. However, if these mechanisms have failed for some reason you can use this command to manually change a revision status from \*(L"Accepted\*(R" to \*(L"Closed\*(R". .IP "\fI\-\-finalize\fR" 4 .IX Item "--finalize" .RE .RS 4 .Sp .RS 4 Close only if the repository is untracked and the revision is accepted. Continue even if the close can't happen. This is a soft version of '' used by other workflows. .RE .RE .RS 4 .IP "\fI\-\-quiet\fR" 4 .IX Item "--quiet" .RE .RS 4 .Sp .RS 4 Do not print a success message. .RE .RE .RS 4 .RE .PP \&\fBcommit\fR [\-\-revision \fIrevision_id\fR] [\-\-show] .Sp .RS 4 Supports: svn Commit a revision which has been accepted by a reviewer. .IP "\fI\-\-revision\fR \fIrevision_id\fR" 4 .IX Item "--revision revision_id" .RE .RS 4 .Sp .RS 4 Commit a specific revision. If you do not specify a revision, arc will look for committable revisions. .RE .RE .RS 4 .IP "\fI\-\-show\fR" 4 .IX Item "--show" .RE .RS 4 .Sp .RS 4 Show the command which would be issued, but do not actually commit anything. .RE .RE .RS 4 .RE .PP \&\fBcover\fR [\-\-rev \fIrevision\fR] [\fIpath\fR ...] .Sp .RS 4 Supports: svn, git, hg Cover your... professional reputation. Show blame for the lines you changed in your working copy (svn) or since some commit (hg, git). This will take a minute because blame takes a minute, especially under \&\s-1SVN.\s0 .IP "\fI\-\-rev\fR \fIrevision\fR" 4 .IX Item "--rev revision" .RE .RS 4 .Sp .RS 4 Supports: git, hg Cover changes since a specific revision. .RE .RE .RS 4 .RE .PP \&\fBdiff\fR [\fIpaths\fR] (svn) .PP \&\fBdiff\fR [\fIcommit\fR] (git, hg) .Sp .RS 4 Supports: git, svn, hg Generate a Differential diff or revision from local changes. .Sp Under git and mercurial, you can specify a commit (like \fIHEAD^^^\fR or \fImaster\fR) and Differential will generate a diff against the merge base of that commit and your current working directory parent. .Sp Under svn, you can choose to include only some of the modified files in the working copy in the diff by specifying their paths. If you omit paths, all changes are included in the diff. .IP "\fI\-\-add\-all\fR, \fI\-a\fR" 4 .IX Item "--add-all, -a" .RE .RS 4 .Sp .RS 4 Automatically add all unstaged and uncommitted files to the commit. .RE .RE .RS 4 .IP "\fI\-\-advice\fR" 4 .IX Item "--advice" .RE .RS 4 .Sp .RS 4 Require excuse for lint advice in addition to lint warnings and errors. .RE .RE .RS 4 .IP "\fI\-\-allow\-untracked\fR" 4 .IX Item "--allow-untracked" .RE .RS 4 .Sp .RS 4 Skip checks for untracked files in the working copy. .RE .RE .RS 4 .IP "\fI\-\-amend\-all\fR" 4 .IX Item "--amend-all" .RE .RS 4 .Sp .RS 4 When linting git repositories, amend \s-1HEAD\s0 with all patches suggested by lint without prompting. .RE .RE .RS 4 .IP "\fI\-\-amend\-autofixes\fR" 4 .IX Item "--amend-autofixes" .RE .RS 4 .Sp .RS 4 When linting git repositories, amend \s-1HEAD\s0 with autofix patches suggested by lint without prompting. .RE .RE .RS 4 .IP "\fI\-\-apply\-patches\fR" 4 .IX Item "--apply-patches" .RE .RS 4 .Sp .RS 4 Apply patches suggested by lint to the working copy without prompting. .RE .RE .RS 4 .IP "\fI\-\-base\fR \fIrules\fR" 4 .IX Item "--base rules" .RE .RS 4 .Sp .RS 4 Supports: git, hg Additional rules for determining base revision. .RE .RE .RS 4 .IP "\fI\-\-browse\fR" 4 .IX Item "--browse" .RE .RS 4 .Sp .RS 4 After creating a diff or revision, open it in a web browser. .RE .RE .RS 4 .IP "\fI\-\-cache\fR \fIbool\fR" 4 .IX Item "--cache bool" .RE .RS 4 .Sp .Vb 1 \& 0 to disable lint cache, 1 to enable (default). .Ve .IP "\fI\-\-cc\fR \fIusernames\fR" 4 .IX Item "--cc usernames" .RE .RS 4 .Sp .RS 4 When creating a revision, add CCs. .RE .RE .RS 4 .IP "\fI\-\-coverage\fR" 4 .IX Item "--coverage" .RE .RS 4 .Sp .RS 4 Always enable coverage information. .RE .RE .RS 4 .IP "\fI\-\-create\fR" 4 .IX Item "--create" .RE .RS 4 .Sp .RS 4 Always create a new revision. .RE .RE .RS 4 .IP "\fI\-\-edit\fR" 4 .IX Item "--edit" .RE .RS 4 .Sp .RS 4 Supports: git, hg When updating a revision under git, edit revision information before updating. .RE .RE .RS 4 .IP "\fI\-\-encoding\fR \fIencoding\fR" 4 .IX Item "--encoding encoding" .RE .RS 4 .Sp .RS 4 Attempt to convert non \s-1UTF\-8\s0 hunks into specified encoding. .RE .RE .RS 4 .IP "\fI\-\-excuse\fR \fIexcuse\fR" 4 .IX Item "--excuse excuse" .RE .RS 4 .Sp .RS 4 Provide a prepared in advance excuse for any lints/tests shall they fail. .RE .RE .RS 4 .IP "\fI\-\-head\fR \fIcommit\fR" 4 .IX Item "--head commit" .RE .RS 4 .Sp .RS 4 Supports: git Specify the end of the commit range. This disables many Arcanist/Phabricator features which depend on having access to the working copy. .RE .RE .RS 4 .IP "\fI\-\-ignore\-unsound\-tests\fR" 4 .IX Item "--ignore-unsound-tests" .RE .RS 4 .Sp .RS 4 Ignore unsound test failures without prompting. .RE .RE .RS 4 .IP "\fI\-\-json\fR" 4 .IX Item "--json" .RE .RS 4 .Sp .RS 4 Emit machine-readable \s-1JSON. EXPERIMENTAL\s0! Probably does not work! .RE .RE .RS 4 .IP "\fI\-\-less\-context\fR" 4 .IX Item "--less-context" .RE .RS 4 .Sp .RS 4 Normally, files are diffed with full context: the entire file is sent to Differential so reviewers can 'show more' and see it. If you are making changes to very large files with tens of thousands of lines, this may not work well. With this flag, a diff will be created that has only a few lines of context. .RE .RE .RS 4 .IP "\fI\-\-lintall\fR" 4 .IX Item "--lintall" .RE .RS 4 .Sp .RS 4 Raise all lint warnings, not just those on lines you changed. .RE .RE .RS 4 .IP "\fI\-\-message\fR \fImessage\fR, \fI\-m\fR \fImessage\fR" 4 .IX Item "--message message, -m message" .RE .RS 4 .Sp .RS 4 When updating a revision, use the specified message instead of prompting. .RE .RE .RS 4 .IP "\fI\-\-message\-file\fR \fIfile\fR, \fI\-F\fR \fIfile\fR" 4 .IX Item "--message-file file, -F file" .RE .RS 4 .Sp .RS 4 When creating a revision, read revision information from this file. .RE .RE .RS 4 .IP "\fI\-\-never\-apply\-patches\fR" 4 .IX Item "--never-apply-patches" .RE .RS 4 .Sp .RS 4 Never apply patches suggested by lint. .RE .RE .RS 4 .IP "\fI\-\-no\-amend\fR" 4 .IX Item "--no-amend" .RE .RS 4 .Sp .RS 4 Never amend commits in the working copy with lint patches. .RE .RE .RS 4 .IP "\fI\-\-no\-coverage\fR" 4 .IX Item "--no-coverage" .RE .RS 4 .Sp .RS 4 Always disable coverage information. .RE .RE .RS 4 .IP "\fI\-\-no\-diff\fR" 4 .IX Item "--no-diff" .RE .RS 4 .Sp .RS 4 Only run lint and unit tests. Intended for internal use. .RE .RE .RS 4 .IP "\fI\-\-nolint\fR" 4 .IX Item "--nolint" .RE .RS 4 .Sp .RS 4 Do not run lint. .RE .RE .RS 4 .IP "\fI\-\-nounit\fR" 4 .IX Item "--nounit" .RE .RS 4 .Sp .RS 4 Do not run unit tests. .RE .RE .RS 4 .IP "\fI\-\-only\fR" 4 .IX Item "--only" .RE .RS 4 .Sp .RS 4 Only generate a diff, without running lint, unit tests, or other auxiliary steps. See also \-\-preview. .RE .RE .RS 4 .IP "\fI\-\-only\-new\fR \fIbool\fR" 4 .IX Item "--only-new bool" .RE .RS 4 .Sp .RS 4 Display only lint messages not present in the original code. .RE .RE .RS 4 .IP "\fI\-\-plan\-changes\fR" 4 .IX Item "--plan-changes" .RE .RS 4 .Sp .RS 4 Create or update a revision without requesting a code review. .RE .RE .RS 4 .IP "\fI\-\-preview\fR" 4 .IX Item "--preview" .RE .RS 4 .Sp .RS 4 Instead of creating or updating a revision, only create a diff, which you may later attach to a revision. This still runs lint unit tests. See also \-\-only. .RE .RE .RS 4 .IP "\fI\-\-raw\fR" 4 .IX Item "--raw" .RE .RS 4 .Sp .RS 4 Read diff from stdin, not from the working copy. This disables many Arcanist/Phabricator features which depend on having access to the working copy. .RE .RE .RS 4 .IP "\fI\-\-raw\-command\fR \fIcommand\fR" 4 .IX Item "--raw-command command" .RE .RS 4 .Sp .RS 4 Generate diff by executing a specified command, not from the working copy. This disables many Arcanist/Phabricator features which depend on having access to the working copy. .RE .RE .RS 4 .IP "\fI\-\-reviewers\fR \fIusernames\fR" 4 .IX Item "--reviewers usernames" .RE .RS 4 .Sp .RS 4 When creating a revision, add reviewers. .RE .RE .RS 4 .IP "\fI\-\-skip\-binaries\fR" 4 .IX Item "--skip-binaries" .RE .RS 4 .Sp .RS 4 Do not upload binaries (like images). .RE .RE .RS 4 .IP "\fI\-\-skip\-staging\fR" 4 .IX Item "--skip-staging" .RE .RS 4 .Sp .RS 4 Do not copy changes to the staging area. .RE .RE .RS 4 .IP "\fI\-\-uncommitted\fR" 4 .IX Item "--uncommitted" .RE .RS 4 .Sp .RS 4 Supports: hg Suppress warning about uncommitted changes. .RE .RE .RS 4 .IP "\fI\-\-update\fR \fIrevision_id\fR" 4 .IX Item "--update revision_id" .RE .RS 4 .Sp .RS 4 Always update a specific revision. .RE .RE .RS 4 .IP "\fI\-\-use\-commit\-message\fR \fIcommit\fR, \fI\-C\fR \fIcommit\fR" 4 .IX Item "--use-commit-message commit, -C commit" .RE .RS 4 .Sp .RS 4 Supports: git Read revision information from a specific commit. .RE .RE .RS 4 .IP "\fI\-\-verbatim\fR" 4 .IX Item "--verbatim" .RE .RS 4 .Sp .RS 4 Supports: hg, git When creating a revision, try to use the working copy commit message verbatim, without prompting to edit it. When updating a revision, update some fields from the local commit message. .RE .RE .RS 4 .RE .PP \&\fBdownload\fR \fIfile\fR [\-\-as \fIname\fR] [\-\-show] .Sp .RS 4 Supports: filesystems Download a file to local disk, e.g.: .Sp .Vb 1 \& $ arc download F33 # Download file \*(AqF33\*(Aq .Ve .IP "\fI\-\-as\fR \fIname\fR" 4 .IX Item "--as name" .RE .RS 4 .Sp .RS 4 Save the file with a specific name rather than the default. .RE .RE .RS 4 .IP "\fI\-\-show\fR" 4 .IX Item "--show" .RE .RS 4 .Sp .RS 4 Write file to stdout instead of to disk. .RE .RE .RS 4 .RE .PP \&\fBexport\fR [\fIpaths\fR] \fIformat\fR (svn) .PP \&\fBexport\fR [\fIcommit_range\fR] \fIformat\fR (git, hg) .PP \&\fBexport\fR \fI\-\-revision\fR \fIrevision_id\fR \fIformat\fR .PP \&\fBexport\fR \fI\-\-diff\fR \fIdiff_id\fR \fIformat\fR .Sp .RS 4 Supports: svn, git, hg Export the local changeset (or a Differential changeset) to a file, in some \fIformat\fR: git diff (\fI\-\-git\fR), unified diff (\fI\-\-unified\fR), or arc bundle (\fI\-\-arcbundle\fR \fIpath\fR) format. .IP "\fI\-\-arcbundle\fR \fIfile\fR" 4 .IX Item "--arcbundle file" .RE .RS 4 .Sp .RS 4 Export change as an arc bundle. This format can represent all changes. These bundles can be applied with 'arc patch'. .RE .RE .RS 4 .IP "\fI\-\-diff\fR \fIdiff_id\fR" 4 .IX Item "--diff diff_id" .RE .RS 4 .Sp .RS 4 Instead of exporting changes from the working copy, export them from a Differential diff. .RE .RE .RS 4 .IP "\fI\-\-encoding\fR \fIencoding\fR" 4 .IX Item "--encoding encoding" .RE .RS 4 .Sp .RS 4 Attempt to convert non \s-1UTF\-8\s0 patch into specified encoding. .RE .RE .RS 4 .IP "\fI\-\-git\fR" 4 .IX Item "--git" .RE .RS 4 .Sp .RS 4 Export change as a git patch. This format is more complete than unified, but less complete than arc bundles. These patches can be applied with 'git apply' or 'arc patch'. .RE .RE .RS 4 .IP "\fI\-\-revision\fR \fIrevision_id\fR" 4 .IX Item "--revision revision_id" .RE .RS 4 .Sp .RS 4 Instead of exporting changes from the working copy, export them from a Differential revision. .RE .RE .RS 4 .IP "\fI\-\-unified\fR" 4 .IX Item "--unified" .RE .RS 4 .Sp .RS 4 Export change as a unified patch. This format is less complete than git patches or arc bundles. These patches can be applied with 'patch' or 'arc patch'. .RE .RE .RS 4 .RE .PP \&\fBfeature\fR [\fIoptions\fR] .PP \&\fBfeature\fR \fIname\fR [\fIstart\fR] .Sp .RS 4 Supports: git, hg A wrapper on 'git branch' or 'hg bookmark'. .Sp Without \fIname\fR, it lists the available branches and their revision status. .Sp With \fIname\fR, it creates or checks out a branch. If the branch \&\fIname\fR doesn't exist and is in format D123 then the branch of revision D123 is checked out. Use \fIstart\fR to specify where the new branch will start. Use 'arc.feature.start.default' to set the default feature start location. .IP "\fI\-\-by\-status\fR" 4 .IX Item "--by-status" .RE .RS 4 .Sp .RS 4 Sort branches by status instead of time. .RE .RE .RS 4 .IP "\fI\-\-output\fR \fIformat\fR" 4 .IX Item "--output format" .RE .RS 4 .Sp .RS 4 With 'json', show features in machine-readable \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-view\-all\fR" 4 .IX Item "--view-all" .RE .RS 4 .Sp .RS 4 Include closed and abandoned revisions. .RE .RE .RS 4 .RE .PP \&\fBflag\fR [\fIobject\fR ...] .PP \&\fBflag\fR \fIobject\fR \-\-clear .PP \&\fBflag\fR \fIobject\fR [\-\-edit] [\-\-color \fIcolor\fR] [\-\-note \fInote\fR] .Sp .RS 4 In the first form, list objects you've flagged. You can provide the names of one or more objects (Maniphest tasks T#, Differential revisions D#, Diffusion references rXXX???, or PHIDs \s-1PHID\-XXX\-\s0???) to print only flags for those objects. .Sp In the second form, clear an existing flag on one object. .Sp In the third form, create or update a flag on one object. Color defaults to blue and note to empty, but if you omit both you must pass \-\-edit. .IP "\fI\-\-clear\fR" 4 .IX Item "--clear" .RE .RS 4 .Sp .RS 4 Delete the flag on an object. .RE .RE .RS 4 .IP "\fI\-\-color\fR \fIcolor\fR" 4 .IX Item "--color color" .RE .RS 4 .Sp .RS 4 Set the color of a flag. .RE .RE .RS 4 .IP "\fI\-\-edit\fR" 4 .IX Item "--edit" .RE .RS 4 .Sp .RS 4 Edit the flag on an object. .RE .RE .RS 4 .IP "\fI\-\-note\fR \fInote\fR" 4 .IX Item "--note note" .RE .RS 4 .Sp .RS 4 Set the note on a flag. .RE .RE .RS 4 .RE .PP \&\fBget-config\fR [\fIoptions\fR] \*(-- [\fIname\fR ...] .Sp .RS 4 Supports: cli Reads an arc configuration option. With no argument, reads all options. .Sp With \fI\-\-verbose\fR, shows detailed information about one or more options. .IP "\fI\-\-verbose\fR" 4 .IX Item "--verbose" .RE .RS 4 .Sp .RS 4 Show detailed information about options. .RE .RE .RS 4 .RE .PP \&\fBhelp\fR [\fIcommand\fR] .PP \&\fBhelp\fR \-\-full .Sp .RS 4 Supports: english Shows this help. With \fIcommand\fR, shows help about a specific command. .IP "\fI\-\-full\fR" 4 .IX Item "--full" .RE .RS 4 .Sp .RS 4 Print detailed information about each command. .RE .RE .RS 4 .RE .PP \&\fBinstall-certificate\fR [uri] .Sp .RS 4 Supports: http, https Installs Conduit credentials into your ~/.arcrc for the given install of Phabricator. You need to do this before you can use 'arc', as it enables 'arc' to link your command-line activity with your account on the web. Run this command from within a project directory to install that project's certificate, or specify an explicit \s-1URI \s0(like \&\*(L"https://phabricator.example.com/\*(R"). .RE .PP \&\fBland\fR [\fIoptions\fR] [\fIref\fR] .Sp .RS 4 Supports: git, hg .Sp Publish an accepted revision after review. This command is the last step in the standard Differential pre-publish code review workflow. .Sp This command merges and pushes changes associated with an accepted revision that are currently sitting in \fIref\fR, which is usually the name of a local branch. Without \fIref\fR, the current working copy state will be used. .Sp Under Git: branches, tags, and arbitrary commits (detached HEADs) may be landed. .Sp Under Mercurial: branches and bookmarks may be landed, but only onto a target of the same type. See T3855. .Sp The workflow selects a target branch to land onto and a remote where the change will be pushed to. .Sp A target branch is selected by examining these sources in order: .Sp .Vb 6 \& \- the B<\-\-onto> flag; \& \- the upstream of the current branch, recursively (Git only); \& \- the I configuration setting; \& \- or by falling back to a standard default: \& \- "master" in Git; \& \- "default" in Mercurial. .Ve .Sp A remote is selected by examining these sources in order: .Sp .Vb 5 \& \- the B<\-\-remote> flag; \& \- the upstream of the current branch, recursively (Git only); \& \- or by falling back to a standard default: \& \- "origin" in Git; \& \- the default remote in Mercurial. .Ve .Sp After selecting a target branch and a remote, the commits which will be landed are printed. .Sp With \fB\-\-preview\fR, execution stops here, before the change is merged. .Sp The change is merged with the changes in the target branch, following these rules: .Sp In repositories with mutable history or with \fB\-\-squash\fR, this will perform a squash merge (the entire branch will be represented as one commit after the merge). .Sp In repositories with immutable history or with \fB\-\-merge\fR, this will perform a strict merge (a merge commit will always be created, and local commits will be preserved). .Sp The resulting commit will be given an up-to-date commit message describing the final state of the revision in Differential. .Sp In Git, the merge occurs in a detached \s-1HEAD.\s0 The local branch reference (if one exists) is not updated yet. .Sp With \fB\-\-hold\fR, execution stops here, before the change is pushed. .Sp The change is pushed into the remote. .Sp Consulting mystical sources of power, the workflow makes a guess about what state you wanted to end up in after the process finishes and the working copy is put into that state. .Sp The branch which was landed is deleted, unless the \fB\-\-keep\-branch\fR flag was passed or the landing branch is the same as the target branch. .IP "\fI\-\-delete\-remote\fR" 4 .IX Item "--delete-remote" .RE .RS 4 .Sp .RS 4 Delete the feature branch in the remote after landing it. .RE .RE .RS 4 .IP "\fI\-\-hold\fR" 4 .IX Item "--hold" .RE .RS 4 .Sp .RS 4 Prepare the change to be pushed, but do not actually push it. .RE .RE .RS 4 .IP "\fI\-\-keep\-branch\fR" 4 .IX Item "--keep-branch" .RE .RS 4 .Sp .RS 4 Keep the feature branch after pushing changes to the remote (by default, it is deleted). .RE .RE .RS 4 .IP "\fI\-\-merge\fR" 4 .IX Item "--merge" .RE .RS 4 .Sp .RS 4 Supports: git Perform a \-\-no\-ff merge, not a \-\-squash merge. If the project is marked as having an immutable history, this is the default behavior. .RE .RE .RS 4 .IP "\fI\-\-onto\fR \fImaster\fR" 4 .IX Item "--onto master" .RE .RS 4 .Sp .RS 4 Land feature branch onto a branch other than the default ('master' in git, 'default' in hg). You can change the default by setting 'arc.land.onto.default' with `arc set\-config` or for the entire project in .arcconfig. .RE .RE .RS 4 .IP "\fI\-\-preview\fR" 4 .IX Item "--preview" .RE .RS 4 .Sp .RS 4 Prints the commits that would be landed. Does not actually modify or land the commits. .RE .RE .RS 4 .IP "\fI\-\-remote\fR \fIorigin\fR" 4 .IX Item "--remote origin" .RE .RS 4 .Sp .RS 4 Push to a remote other than the default ('origin' in git). .RE .RE .RS 4 .IP "\fI\-\-revision\fR \fIid\fR" 4 .IX Item "--revision id" .RE .RS 4 .Sp .RS 4 Use the message from a specific revision, rather than inferring the revision based on branch content. .RE .RE .RS 4 .IP "\fI\-\-squash\fR" 4 .IX Item "--squash" .RE .RS 4 .Sp .RS 4 Perform a \-\-squash merge, not a \-\-no\-ff merge. If the project is marked as having a mutable history, this is the default behavior. .RE .RE .RS 4 .IP "\fI\-\-update\-with\-merge\fR" 4 .IX Item "--update-with-merge" .RE .RS 4 .Sp .RS 4 Supports: git When updating the feature branch, use merge instead of rebase. This is the default behavior. Setting arc.land.update.default to 'merge' can also be used to make this the default. .RE .RE .RS 4 .IP "\fI\-\-update\-with\-rebase\fR" 4 .IX Item "--update-with-rebase" .RE .RS 4 .Sp .RS 4 Supports: git When updating the feature branch, use rebase instead of merge. This might make things work better in some cases. Set arc.land.update.default to 'rebase' to make this the default. .RE .RE .RS 4 .RE .PP \&\fBliberate\fR [\fIpath\fR] .Sp .RS 4 Supports: libphutil Create or update a libphutil library, generating required metadata files like \fIinit\fR.php. .IP "\fI\-\-all\fR" 4 .IX Item "--all" .RE .RS 4 .Sp .RS 4 Drop the module cache before liberating. This will completely reanalyze the entire library. Thorough, but slow! .RE .RE .RS 4 .IP "\fI\-\-force\-update\fR" 4 .IX Item "--force-update" .RE .RS 4 .Sp .RS 4 Force the library map to be updated, even in the presence of lint errors. .RE .RE .RS 4 .IP "\fI\-\-library\-name\fR \fIname\fR" 4 .IX Item "--library-name name" .RE .RS 4 .Sp .RS 4 Use a flag for library name rather than awaiting user input. .RE .RE .RS 4 .RE .PP \&\fBlint\fR [\fIoptions\fR] [\fIpaths\fR] .PP \&\fBlint\fR [\fIoptions\fR] \-\-rev [\fIrev\fR] .Sp .RS 4 Supports: git, svn, hg Run static analysis on changes to check for mistakes. If no files are specified, lint will be run on all files which have been modified. .IP "\fI\-\-amend\-all\fR" 4 .IX Item "--amend-all" .RE .RS 4 .Sp .RS 4 When linting git repositories, amend \s-1HEAD\s0 with all patches suggested by lint without prompting. .RE .RE .RS 4 .IP "\fI\-\-amend\-autofixes\fR" 4 .IX Item "--amend-autofixes" .RE .RS 4 .Sp .RS 4 When linting git repositories, amend \s-1HEAD\s0 with autofix patches suggested by lint without prompting. .RE .RE .RS 4 .IP "\fI\-\-apply\-patches\fR" 4 .IX Item "--apply-patches" .RE .RS 4 .Sp .RS 4 Apply patches suggested by lint to the working copy without prompting. .RE .RE .RS 4 .IP "\fI\-\-cache\fR \fIbool\fR" 4 .IX Item "--cache bool" .RE .RS 4 .Sp .Vb 3 \& 0 to disable cache, 1 to enable. The default value is \& determined by \*(Aqarc.lint.cache\*(Aq in configuration, which defaults \& to off. See notes in \*(Aqarc.lint.cache\*(Aq. .Ve .IP "\fI\-\-engine\fR \fIclassname\fR" 4 .IX Item "--engine classname" .RE .RS 4 .Sp .RS 4 Override configured lint engine for this project. .RE .RE .RS 4 .IP "\fI\-\-everything\fR" 4 .IX Item "--everything" .RE .RS 4 .Sp .RS 4 Lint all files in the project. .RE .RE .RS 4 .IP "\fI\-\-lintall\fR" 4 .IX Item "--lintall" .RE .RS 4 .Sp .RS 4 Show all lint warnings, not just those on changed lines. When paths are specified, this is the default behavior. .RE .RE .RS 4 .IP "\fI\-\-never\-apply\-patches\fR" 4 .IX Item "--never-apply-patches" .RE .RS 4 .Sp .RS 4 Never apply patches suggested by lint. .RE .RE .RS 4 .IP "\fI\-\-only\-changed\fR" 4 .IX Item "--only-changed" .RE .RS 4 .Sp .RS 4 Show lint warnings just on changed lines. When no paths are specified, this is the default. This differs from only-new in cases where line modifications introduce lint on other unmodified lines. .RE .RE .RS 4 .IP "\fI\-\-only\-new\fR \fIbool\fR" 4 .IX Item "--only-new bool" .RE .RS 4 .Sp .RS 4 Supports: git, hg Display only messages not present in the original code. .RE .RE .RS 4 .IP "\fI\-\-outfile\fR \fIpath\fR" 4 .IX Item "--outfile path" .RE .RS 4 .Sp .RS 4 Output the linter results to a file. Defaults to stdout. .RE .RE .RS 4 .IP "\fI\-\-output\fR \fIformat\fR" 4 .IX Item "--output format" .RE .RS 4 .Sp .RS 4 With 'summary', show lint warnings in a more compact format. With 'json', show lint warnings in machine-readable \s-1JSON\s0 format. With 'none', show no lint warnings. With 'compiler', show lint warnings in suitable for your editor. With 'xml', show lint warnings in the Checkstyle \s-1XML\s0 format. .RE .RE .RS 4 .IP "\fI\-\-rev\fR \fIrevision\fR" 4 .IX Item "--rev revision" .RE .RS 4 .Sp .RS 4 Supports: git, hg Lint changes since a specific revision. .RE .RE .RS 4 .IP "\fI\-\-severity\fR \fIstring\fR" 4 .IX Item "--severity string" .RE .RS 4 .Sp .RS 4 Set minimum message severity. One of: 'advice', 'autofix', \&'warning', 'error', 'disabled'. Defaults to 'advice'. .RE .RE .RS 4 .RE .PP \&\fBlinters\fR [\fIoptions\fR] [\fIname\fR] .Sp .RS 4 Supports: cli List the available and configured linters, with information about what they do and which versions are installed. .Sp if \fIname\fR is provided, the linter with that name will be displayed. .IP "\fI\-\-search\fR \fIsearch\fR" 4 .IX Item "--search search" .RE .RS 4 .Sp .RS 4 Search for linters. Search is case-insensitive, and is performedagainst name and description of each linter. .RE .RE .RS 4 .IP "\fI\-\-verbose\fR" 4 .IX Item "--verbose" .RE .RS 4 .Sp .RS 4 Show detailed information, including options. .RE .RE .RS 4 .RE .PP \&\fBlist\fR .Sp .RS 4 Supports: git, svn, hg List your open Differential revisions. .RE .PP \&\fBpaste\fR [\-\-title \fItitle\fR] [\-\-lang \fIlanguage\fR] [\-\-json] .PP \&\fBpaste\fR \fIid\fR [\-\-json] .Sp .RS 4 Supports: text Share and grab text using the Paste application. To create a paste, use stdin to provide the text: .Sp .Vb 1 \& $ cat list_of_ducks.txt | arc paste .Ve .Sp To retrieve a paste, specify the paste \s-1ID:\s0 .Sp .Vb 1 \& $ arc paste P123 .Ve .IP "\fI\-\-json\fR" 4 .IX Item "--json" .RE .RS 4 .Sp .RS 4 Output in \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-lang\fR \fIlanguage\fR" 4 .IX Item "--lang language" .RE .RS 4 .Sp .RS 4 Language for syntax highlighting. .RE .RE .RS 4 .IP "\fI\-\-title\fR \fItitle\fR" 4 .IX Item "--title title" .RE .RS 4 .Sp .RS 4 Title for the paste. .RE .RE .RS 4 .RE .PP \&\fBpatch\fR \fID12345\fR .PP \&\fBpatch\fR \fI\-\-revision\fR \fIrevision_id\fR .PP \&\fBpatch\fR \fI\-\-diff\fR \fIdiff_id\fR .PP \&\fBpatch\fR \fI\-\-patch\fR \fIfile\fR .PP \&\fBpatch\fR \fI\-\-arcbundle\fR \fIbundlefile\fR .Sp .RS 4 Supports: git, svn, hg Apply the changes in a Differential revision, patchfile, or arc bundle to the working copy. .IP "\fI\-\-arcbundle\fR \fIbundlefile\fR" 4 .IX Item "--arcbundle bundlefile" .RE .RS 4 .Sp .RS 4 Apply changes from an arc bundle generated with 'arc export'. .RE .RE .RS 4 .IP "\fI\-\-diff\fR \fIdiff_id\fR" 4 .IX Item "--diff diff_id" .RE .RS 4 .Sp .RS 4 Apply changes from a Differential diff. Normally you want to use \-\-revision to get the most recent changes, but you can specifically apply an out-of-date diff or a diff which was never attached to a revision by using this flag. .RE .RE .RS 4 .IP "\fI\-\-encoding\fR \fIencoding\fR" 4 .IX Item "--encoding encoding" .RE .RS 4 .Sp .RS 4 Attempt to convert non \s-1UTF\-8\s0 patch into specified encoding. .RE .RE .RS 4 .IP "\fI\-\-force\fR" 4 .IX Item "--force" .RE .RS 4 .Sp .RS 4 Do not run any sanity checks. .RE .RE .RS 4 .IP "\fI\-\-nobranch\fR" 4 .IX Item "--nobranch" .RE .RS 4 .Sp .RS 4 Supports: git, hg Normally, a new branch (git) or bookmark (hg) is created and then the patch is applied and committed in the new branch/bookmark. This flag cherry-picks the resultant commit onto the original branch and deletes the temporary branch. .RE .RE .RS 4 .IP "\fI\-\-nocommit\fR" 4 .IX Item "--nocommit" .RE .RS 4 .Sp .RS 4 Supports: git, hg Normally under git/hg, if the patch is successful, the changes are committed to the working copy. This flag prevents the commit. .RE .RE .RS 4 .IP "\fI\-\-patch\fR \fIpatchfile\fR" 4 .IX Item "--patch patchfile" .RE .RS 4 .Sp .RS 4 Apply changes from a git patchfile or unified patchfile. .RE .RE .RS 4 .IP "\fI\-\-revision\fR \fIrevision_id\fR" 4 .IX Item "--revision revision_id" .RE .RS 4 .Sp .RS 4 Apply changes from a Differential revision, using the most recent diff that has been attached to it. You can run 'arc patch D12345' as a shorthand. .RE .RE .RS 4 .IP "\fI\-\-skip\-dependencies\fR" 4 .IX Item "--skip-dependencies" .RE .RS 4 .Sp .RS 4 Supports: git, hg Normally, if a patch has dependencies that are not present in the working copy, arc tries to apply them as well. This flag prevents such work. .RE .RE .RS 4 .IP "\fI\-\-update\fR" 4 .IX Item "--update" .RE .RS 4 .Sp .RS 4 Supports: git, svn, hg Update the local working copy before applying the patch. .RE .RE .RS 4 .RE .PP \&\fBrevert\fR Please use arc backout instead .PP \&\fBset-config\fR [\fIoptions\fR] \*(-- \fIname\fR \fIvalue\fR .Sp .RS 4 Supports: cli Sets an arc configuration option. .Sp Options are either user (apply to all arc commands you invoke from the current user) or local (apply only to the current working copy). By default, user configuration is written. Use \fI\-\-local\fR to write local configuration. .Sp User values are written to '~/.arcrc' on Linux and Mac \s-1OS X,\s0 and an undisclosed location on Windows. Local values are written to an arc directory under either .git, .hg, or .svn as appropriate. .IP "\fI\-\-local\fR" 4 .IX Item "--local" .RE .RS 4 .Sp .RS 4 Set a local config value instead of a user one. .RE .RE .RS 4 .RE .PP \&\fBshell-complete\fR \fI\-\-current\fR \fIN\fR \*(-- [\fIargv\fR] .Sp .RS 4 Supports: bash, etc. Implements shell completion. To use shell completion, source the appropriate script from 'resources/shell/' in your .shellrc. .IP "\fI\-\-current\fR \fIcursor_position\fR" 4 .IX Item "--current cursor_position" .RE .RS 4 .Sp .RS 4 Current term in the argument list being completed. .RE .RE .RS 4 .RE .PP \&\fBstart\fR \fIobject\fR .Sp .RS 4 Start tracking work in Phrequent. .RE .PP \&\fBstop\fR [\-\-note \fInote\fR] [\fIobjects\fR] .Sp .RS 4 Stop tracking work in Phrequent. .IP "\fI\-\-note\fR \fInote\fR" 4 .IX Item "--note note" .RE .RS 4 .Sp .RS 4 A note to attach to the tracked time. .RE .RE .RS 4 .RE .PP \&\fBtasks\fR [\fIoptions\fR] View all assigned tasks. .IP "\fI\-\-limit\fR \fIn\fR" 4 .IX Item "--limit n" .Sp .RS 4 Limit the amount of tasks outputted, default is all. .RE .IP "\fI\-\-order\fR \fItask_order\fR" 4 .IX Item "--order task_order" .Sp .RS 4 Arrange tasks based on priority, created, or modified, default is priority. .RE .IP "\fI\-\-owner\fR \fIusername\fR" 4 .IX Item "--owner username" .Sp .RS 4 Only show tasks assigned to the given username, also accepts \&\f(CW@all\fR to show all, default is you. .RE .IP "\fI\-\-status\fR \fItask_status\fR" 4 .IX Item "--status task_status" .Sp .RS 4 Show tasks that are open or closed, default is open. .RE .IP "\fI\-\-unassigned\fR" 4 .IX Item "--unassigned" .Sp .RS 4 Only show tasks that are not assigned (upforgrabs). .RE .PP \&\fBtime\fR .Sp .RS 4 Show what you're currently tracking in Phrequent. .RE .PP \&\fBtodo\fR \fIsummary\fR [\fIoptions\fR] Quickly create a task for yourself. .IP "\fI\-\-browse\fR" 4 .IX Item "--browse" .Sp .RS 4 After creating the task, open it in a web browser. .RE .IP "\fI\-\-cc\fR \fIcc\fR, \fI\-C\fR \fIcc\fR" 4 .IX Item "--cc cc, -C cc" .Sp .RS 4 Other users to \s-1CC\s0 on the new task. .RE .IP "\fI\-\-project\fR \fIproject\fR" 4 .IX Item "--project project" .Sp .RS 4 Projects to assign to the task. .RE .PP \&\fBunit\fR [\fIoptions\fR] [\fIpaths\fR] .PP \&\fBunit\fR [\fIoptions\fR] \-\-rev [\fIrev\fR] .Sp .RS 4 Supports: git, svn, hg Run unit tests that cover specified paths. If no paths are specified, unit tests covering all modified files will be run. .IP "\fI\-\-coverage\fR" 4 .IX Item "--coverage" .RE .RS 4 .Sp .RS 4 Always enable coverage information. .RE .RE .RS 4 .IP "\fI\-\-detailed\-coverage\fR" 4 .IX Item "--detailed-coverage" .RE .RS 4 .Sp .RS 4 Show a detailed coverage report on the \s-1CLI.\s0 Implies \-\-coverage. .RE .RE .RS 4 .IP "\fI\-\-engine\fR \fIclassname\fR" 4 .IX Item "--engine classname" .RE .RS 4 .Sp .RS 4 Override configured unit engine for this project. .RE .RE .RS 4 .IP "\fI\-\-everything\fR" 4 .IX Item "--everything" .RE .RS 4 .Sp .RS 4 Run every test. .RE .RE .RS 4 .IP "\fI\-\-json\fR" 4 .IX Item "--json" .RE .RS 4 .Sp .RS 4 Report results in \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-no\-coverage\fR" 4 .IX Item "--no-coverage" .RE .RS 4 .Sp .RS 4 Always disable coverage information. .RE .RE .RS 4 .IP "\fI\-\-output\fR \fIformat\fR" 4 .IX Item "--output format" .RE .RS 4 .Sp .RS 4 With 'full', show full pretty report (Default). With 'json', report results in \s-1JSON\s0 format. With 'ugly', use uglier (but more efficient) \s-1JSON\s0 formatting. With 'none', don't print results. .RE .RE .RS 4 .IP "\fI\-\-rev\fR \fIrevision\fR" 4 .IX Item "--rev revision" .RE .RS 4 .Sp .RS 4 Supports: git, hg Run unit tests covering changes since a specific revision. .RE .RE .RS 4 .IP "\fI\-\-target\fR \fIphid\fR" 4 .IX Item "--target phid" .RE .RS 4 .Sp .Vb 1 \& (PROTOTYPE) Record a copy of the test results on the specified .Ve .Sp .RS 4 Harbormaster build target. .RE .RE .RS 4 .IP "\fI\-\-ugly\fR" 4 .IX Item "--ugly" .RE .RS 4 .Sp .RS 4 With \-\-json, use uglier (but more efficient) formatting. .RE .RE .RS 4 .RE .PP \&\fBupgrade\fR .Sp .RS 4 Supports: cli Upgrade arcanist and libphutil to the latest versions. .RE .PP \&\fBupload\fR \fIfile\fR [\fIfile\fR ...] [\-\-json] .Sp .RS 4 Supports: filesystems Upload a file from local disk. .IP "\fI\-\-json\fR" 4 .IX Item "--json" .RE .RS 4 .Sp .RS 4 Output upload information in \s-1JSON\s0 format. .RE .RE .RS 4 .IP "\fI\-\-temporary\fR" 4 .IX Item "--temporary" .RE .RS 4 .Sp .RS 4 Mark the file as temporary. Temporary files will be deleted automatically after 24 hours. .RE .RE .RS 4 .RE .PP \&\fBversion\fR [\fIoptions\fR] .Sp .RS 4 Supports: cli Shows the current version of arcanist. .RE .PP \&\fBwhich\fR [options] (svn) .PP \&\fBwhich\fR [options] [\fIcommit\fR] (hg, git) .Sp .RS 4 Supports: svn, git, hg Shows which repository the current working copy corresponds to, which commits 'arc diff' will select, and which revision is in the working copy (or which revisions, if more than one matches). .IP "\fI\-\-any\-status\fR" 4 .IX Item "--any-status" .RE .RS 4 .Sp .RS 4 Show committed and abandoned revisions. .RE .RE .RS 4 .IP "\fI\-\-base\fR \fIrules\fR" 4 .IX Item "--base rules" .RE .RS 4 .Sp .RS 4 Supports: git, hg Additional rules for determining base revision. .RE .RE .RS 4 .IP "\fI\-\-head\fR \fIcommit\fR" 4 .IX Item "--head commit" .RE .RS 4 .Sp .RS 4 Supports: git Specify the end of the commit range to select. .RE .RE .RS 4 .IP "\fI\-\-show\-base\fR" 4 .IX Item "--show-base" .RE .RS 4 .Sp .RS 4 Supports: git, hg Print base commit only and exit. .RE .RE .RS 4 .RE .SH "OPTION REFERENCE" .IX Header "OPTION REFERENCE" .IP "\fI\-\-trace\fR" 4 .IX Item "--trace" .PP Debugging command. Shows underlying commands as they are executed, and full stack traces when exceptions are thrown. .IP "\fI\-\-no\-ansi\fR" 4 .IX Item "--no-ansi" .PP Output in plain \s-1ASCII\s0 text only, without color or style. .IP "\fI\-\-ansi\fR" 4 .IX Item "--ansi" .PP Use formatting even in environments which probably don't support it. Example: arc \-\-ansi unit | less \-r .IP "\fI\-\-load\-phutil\-library=/path/to/library\fR" 4 .IX Item "--load-phutil-library=/path/to/library" .PP Ignore libraries listed in .arcconfig and explicitly load specified libraries instead. Mostly useful for Arcanist development. .IP "\fI\-\-conduit\-uri\fR \fIuri\fR" 4 .IX Item "--conduit-uri uri" .PP Ignore configured Conduit \s-1URI\s0 and use an explicit one instead. Mostly useful for Arcanist development. .IP "\fI\-\-conduit\-token\fR \fItoken\fR" 4 .IX Item "--conduit-token token" .PP Ignore configured credentials and use an explicit \s-1API\s0 token instead. .IP "\fI\-\-conduit\-version\fR \fIversion\fR" 4 .IX Item "--conduit-version version" .PP Ignore software version and claim to be running some other version instead. Mostly useful for Arcanist development. May cause bad things to happen. .IP "\fI\-\-conduit\-timeout\fR \fItimeout\fR" 4 .IX Item "--conduit-timeout timeout" .PP Override the default Conduit timeout. Specified in seconds. .IP "\fI\-\-config\fR \fIkey=value\fR" 4 .IX Item "--config key=value" .PP Specify a runtime configuration value. This will take precedence over static values, and only affect the current arcanist invocation. .IP "\fI\-\-skip\-arcconfig\fR" 4 .IX Item "--skip-arcconfig" .PP Skip the working copy configuration file .IP "\fI\-\-arcrc\-file\fR \fIfilename\fR" 4 .IX Item "--arcrc-file filename" .PP Use provided file instead of ~/.arcrc.