Perforce APIhelp.perforce.com ↗

"""Walkthrough: P4Docs SDK — browse commands, search docs, inspect configurables."""
from parse_apis.perforce_p4_cli_documentation_api import P4Docs, Query, CommandName, CommandNotFound

client = P4Docs()

# List available commands from the reference index.
for cmd_summary in client.commandsummaries.list(limit=5):
    print(cmd_summary.command, cmd_summary.url)

# Drill into a specific command's full documentation.
sync_cmd = client.commands.get(command_name=CommandName.P4_SYNC)
print(sync_cmd.syntax)
for opt in sync_cmd.options[:3]:
    print(opt.flag, opt.description[:60])

# Search documentation for a topic.
result = client.searchresults.search(query=Query.SYNC, limit=1).first()
if result:
    print(result.title, result.abstract[:80])

# Navigate from a summary to full command details.
first_summary = client.commandsummaries.list(limit=1).first()
if first_summary:
    detail = first_summary.details()
    print(detail.command, detail.syntax)

# Typed error handling for a missing command.
try:
    client.commands.get(command_name="p4 nonexistent")
except CommandNotFound as exc:
    print(f"Not found: {exc.command_name}")

# Fetch the full p4 client reference page.
client_page = client.clientpages.get()
print(client_page.title, client_page.syntax[:60])

# Inspect client workspace options and configurables.
for opt in client.clientoptions.list(limit=3):
    print(opt.option, opt.default, opt.meaning[:50])

for cfg in client.configurables.list(limit=3):
    print(cfg.name, cfg.client_server_proxy, cfg.default)

print("Exercised: commandsummaries.list / commands.get / searchresults.search / details / clientpages.get / clientoptions.list / configurables.list")