Helix Core is now P4. Product user interfaces will be updated soon. Learn more >>

P4V API for JavaScript Documentation | 2025.2

# How to use this developer guide

## P4VJS Directory

Throughout this guide, `<P4VJS Directory>` represents the following path:

Platform | <P4VJS Directory> path
--- | ---
Windows | `<installation_root>/Perforce/P4VResources/p4vjs`
Linux | `<installation_root>\Perforce\P4VResources\p4vjs`
Mac | `p4v.app/Contents/Resources/p4vjs`

## Navigation

Use following controls to navigate the content in this manual:

- The arrow buttons and at the top of any page bring you to the next or previous heading.

- The links at the top of any page indicate the location of a topic in the hierarchy.

- The icons in the footer of any page provide links to resources such as the Documentation Portal and the Video Library.

## Search tips

- Multiple search terms find topics with one or more of the terms, and each term gets a different highlight color.

- For an exact multi-word search, enclose the set of terms within quotes to form a single string:

  - work also finds workspace, but `"work"` excludes workspace.
  - request also finds requests and requesting, but `"request"` excludes them.
  - configuration also finds topics with configuring, but `"configuration"` excludes them.
- To customize your search further, add an operator (and, not, or) between search terms:
  - configuration and settings narrows your search and only finds topics that contain both configuration and settings.
  - configuration not settings widens your search and finds topics that contain configuration but not settings, topics that contain settings but not configuration, and excludes topics that contain both.
  - configuration or settings widens your search and finds topics that contain configuration or settings and also topics that contain both configuration and settings.
  - If your search contains an operator that you want to use as a word, enclose the phrase in quotes to tell search not to use it as an operator. For example, not required will return a search format error, but "not required" finds topics that contain not required.
- You can search for any string on a page with CTRL+F on Windows or Command-F on macOS.

## Syntax conventions

P4 documentation uses the following conventions for command-line syntax.

Notation | Meaning | Example of Syntax and Command
--- | --- | ---
`literal` | Must be used in the command exactly as shown. |
    p4 revert -So
    p4 revert -So
italics | A parameter for which you must supply specific information. |
    p4 user -d username
`p4 user -d msmith`
`-a -b` or `--a --b` | Both elements are required. |
    p4 renameuser --from=old --to=new
`p4 rename msmith mjones`
`[-a -b]` | Any combination of the enclosed elements is allowed and none of the elements are required. Omit the brackets when you compose the command. |
    p4 delete  [-n -k -v]  file ...
    p4 delete readme.txt
`[-a | -b]` | Exactly one of the enclosed elements is allowed and none of the elements are required. Omit the brackets when you compose the command. |
    p4  group [-a | -A] groupname
    p4 group admins
`{-a | -b}` | Exactly one of the enclosed elements is required. Omit the curly braces when you compose the command. |
    p4 bgtask {-e command | -t triggerName}
    p4 bgtask -t fileSizeCheckTrigger
... | Previous argument can be repeated. ... has a different meaning for directories. See Wildcards in the P4 CLI Reference. |
    p4 [g-opts] streamlog [ -l -L -t -m max ] stream1 ...
    p4 streamlog //project1/s1 //project1/s2

## Feedback

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

## Other documentation

See Perforce documentation.

For support articles, such as troubleshooting and integration information, see the Perforce Knowledge Base.

Your search for returned results