Launching P4V components from the command-line client, P4VC

P4VC is a command-line client that can send certain P4 command-line commands to P4V without having to open a full P4V instance. For example, some users of the P4 command-line client might find P4VC to be a convenient way to occasionally view the Revision Graph or the Stream Graph.

Command Syntax

Command-line help is available:

p4vc -h displays the list of options:

p4vc [options] command [arg ...]

Options:
    -h -?           print this message
    -V              print client version
    -c client       set client name (default $P4CLIENT)
    -C charset      set character set (default $P4CHARSET)
    -p port         set server port (default $P4PORT)
    -u user         set user's username (default $P4USER)

p4vc -help displays the list of commands.

The following table summarizes the output of p4vc help [command] for each command:

Command

Purpose

Syntax

help Print the requested help message p4vc [options] help
branchmappings Shows the list of branch mappings p4vc [options] branchmappings
branches Same as branchmappings. Shows the list of branch mappings p4vc [options] branches
diff Show the diff dialog p4vc [options] diff [ file(s) ]
diffhave Diff opened files against have revision (local paths) p4vc [options] diffhave [ file(s) ]
diffprev Diff against a previous revision (depot path#revision) p4vc [options] diffprev [ file(s) ]
groups Show the list of groups p4vc [options] groups
branch Show/Edit branch p4vc [options] branch [ spec, ... ]
change Show/Edit change p4vc [options] change [ spec, ... ]
client Same as workspace. Show/Edit workspace p4vc [options] client [ spec, ... ]
workspace Show/Edit workspace p4vc [options] workspace [ spec, ... ]
depot Show/Edit depot p4vc [options] depot [ spec, ... ]
group Show/Edit group p4vc [options] group [ spec, ... ]
job Show/Edit job p4vc [options] job [ spec, ... ]
label Show/Edit label p4vc [options] label [ spec, ... ]
user Show/Edit user p4vc [options] user [ spec, ... ]
jobs Show the list of jobs p4vc [options] jobs
labels Show the list of labels p4vc [options] labels
pendingchanges Show the list of pending changes p4vc [options] pendingchanges
history Shows file history p4vc [options] history [ file(s), ... ]
properties Shows file details p4vc [options] properties [ file(s), ... ]
resolve Launches resolve dialog p4vc [options] resolve [ -f ] [ -c num ] [ file(s), ... ]
revisiongraph Shows the revision graph p4vc [options] revisiongraph [ file(s), ... ]
revgraph Same as revisiongraph. Shows the revision graph. p4vc [options] revgraph [ file(s), ... ]
streamgraph Shows the stream graph pane p4vc [options] streamgraph [ file(s) ]
streams Shows the list of streams p4vc [options] streams
submit Launch the submit dialog p4vc [options] submit [ -c num ] [ file(s), ... ]
submittedchanges Show the list of submitted changes p4vc [options] submittedchanges
timelapse Show time-lapse view. See Viewing file history with Time-lapse View. p4vc [options] timelapse [-l linenumber] [ file(s), ... ]
timelapseview Same as timelapse. Show time-lapse view. p4vc [options] timelapseview [ file(s), ... ]
tlv Same as timelapse. Show time-lapse view. p4vc [options] tlv [ file(s), ... ]
topology

Graphically display the topology data in the specified json-file that contains the output of the p4 -Mj -ztag topology command. See p4 topology in Helix Core Command-Line (P4) Reference and Topology tab in P4Admin User Guide.

Important

Features offered in Technology Preview are experimental and not guaranteed to always work as expected. If you have feedback and functionality suggestions, email [email protected].

p4vc [options] topology json-file
user Show/Edit user p4vc [options] user
users Show the list of users p4vc [options] users
workspaces Show the list of workspaces p4vc [options] workspaces
workspacewindow

Launches a WorkspaceWindow for the provided connection. If the window is already opened, it will be brought to the foreground, and the requested selection will be applied.

-s takes a filepath in local or depot format. The file will be selected in either the workspace or depot browser.

-t takes a tab label specifying the active tab. The recognized values are: pending, submitted, files, branches, workspaces, jobs, streams, streamgraph, labels and remotes

p4vc [options] workspacewindow [ -s path ] [ -t tab ]
clients Same as workspaces. Show the list of workspaces. p4vc [options] clients
shutdown

Shut downs the p4v service.
This command does not require a client workspace.

p4vc [options] shutdown
Note
  • Host = localhost Port = 7999
  • The first command sent from P4VC launches a background process. If it fails, the connection timeout is 45 seconds
  • Submit HTML Actions are available with P4VC. HTML Actions provide a way to customize behavior before or after a Submit action. To develop your own custom HTML Actions, see the Add custom HTML pages to P4V topic in the P4VJS Developer Guide.
  • Helix Swarm is unavailable with P4VC