Differential D25007 Diff 23 src/docs/user/userguide/arcanist.diviner

Changeset View

Standalone View

src/docs/user/userguide/arcanist.diviner

	@title Arcanist User Guide			@title Arcanist User Guide
	@group userguide			@group userguide

	Guide to Arcanist, a command-line interface to Phabricator.			Guide to Arcanist, a command-line interface to Phorge.

	Arcanist provides command-line access to many Phabricator tools (like			Arcanist provides command-line access to many Phorge tools (like
	Differential, Files, and Paste), integrates with static analysis ("lint") and			Differential, Files, and Paste), integrates with static analysis ("lint") and
	unit tests, and manages common workflows like getting changes into Differential			unit tests, and manages common workflows like getting changes into Differential
	for review.			for review.

	A detailed command reference is available by running `arc help`. This			A detailed command reference is available by running `arc help`. This
	document provides an overview of common workflows and installation.			document provides an overview of common workflows and installation.

	Arcanist has technical, contributor-focused documentation here:			Arcanist has technical, contributor-focused documentation here:
	<https://secure.phabricator.com/book/arcanist/>			<https://we.phorge.it/book/arcanist/>

	= Quick Start =			= Quick Start =

	A quick start guide is available at @{article:Arcanist Quick Start}. It provides			A quick start guide is available at @{article:Arcanist Quick Start}. It provides
	a much more compact summary of how to get `arc` set up and running for a new			a much more compact summary of how to get `arc` set up and running for a new
	project. You may want to start there, and return here if you need more			project. You may want to start there, and return here if you need more
	information.			information.

	▲ Show 20 Lines • Show All 114 Lines • ▼ Show 20 Lines
	three sources, in order:			three sources, in order:

	# A project can specify configuration in an `.arcconfig` file. This file is			# A project can specify configuration in an `.arcconfig` file. This file is
	JSON, and can be updated using `arc set-config --local` or by editing			JSON, and can be updated using `arc set-config --local` or by editing
	it manually.			it manually.
	# User configuration is read from `~/.arcconfig`. This file is JSON, and can			# User configuration is read from `~/.arcconfig`. This file is JSON, and can
	be updated using `arc set-config`.			be updated using `arc set-config`.
	# Host configuration is read from `/etc/arcconfig` (on Windows, the path			# Host configuration is read from `/etc/arcconfig` (on Windows, the path
	is `C:\ProgramData\Phabricator\Arcanist\config`).			is `C:\ProgramData\Phorge\Arcanist\config`).

	Arcanist uses the first definition it encounters as the runtime setting.			Arcanist uses the first definition it encounters as the runtime setting.

	Existing settings can be printed with `arc get-config`.			Existing settings can be printed with `arc get-config`.

	Use `arc help set-config` and `arc help get-config` for more information			Use `arc help set-config` and `arc help get-config` for more information
	about reading and writing configuration.			about reading and writing configuration.

	Show All 18 Lines