How to use this guide

This guide contains details about using the derived API for Python to create scripts that interact with Helix Versioning Engine. You can download the P4Python API from the Perforce web site at https://www.perforce.com/downloads/helix-core-api-python.

The derived API for Python depends on the Helix C/C++ API, details for which are at Helix C/C++ API User Guide at https://www.perforce.com/perforce/doc.current/manuals/p4api/.

Search

Use quotes for an exact phrase:

To search within a page that is long, use Command-F (Mac) or CTRL+F (PC)

If you enter multiple search terms:

 

 

the hits show a different color for each term:

Navigation

You can remove the colors,
as well as browse from topic to topic with the arrow buttons:
The top of each page indicates where the topic is:
The bottom of every page has links to resources:

You can use links using standard URLs, such as https://www.perforce.com/perforce/doc.current/manuals/cmdref/#CmdRef/p4_add.html#Examples even if you see extra characters after that.

You can resize the Content pane

Feedback

How can we improve this manual? Email us at manual@perforce.com.

Other documentation

See https://www.perforce.com/support/self-service-resources/documentation.

Syntax conventions

Helix documentation uses the following syntax conventions to describe command line syntax.

Notation Meaning
literal Must be used in the command exactly as shown.
italics A parameter for which you must supply specific information. For example, for a serverid parameter, supply the ID of the server.
[-f] The enclosed elements are optional. Omit the brackets when you compose the command.
...
  • Repeats as much as needed:

    • alias-name[[$(arg1)...[$(argn)]]=transformation
  • Recursive for all directory levels:
    • clone perforce:1666 //depot/main/p4... ~/local-repos/main

    • p4 repos -e //gra.../rep...
element1 | element2 Either element1 or element2 is required.