Skip to content

Command reference

Every usage pattern the pyrevit command line accepts, generated from dev/pyRevitLabs/pyRevitCLI/Resources/UsagePatterns.txt.

General

pyrevit (-h | --help)
pyrevit (-V | --version)
pyrevit --usage
pyrevit (wiki | blog | docs | source | youtube | support)

env

pyrevit env [--json] [--redact] [(-h | --help)] [--log=<log_file>]
pyrevit env path [(-h | --help)]
pyrevit env path list [--scope=<scope>] [--log=<log_file>]
pyrevit env path ensure <dir> [--scope=<scope>] [--first] [--log=<log_file>]
pyrevit env path remove <dir> [--scope=<scope>] [--log=<log_file>]
pyrevit env path which [--log=<log_file>]

update

pyrevit update [--help] [--log=<log_file>]

clone

pyrevit clone (-h | --help)
pyrevit clone <clone_name> <deployment_name> [--dest=<dest_path>] [--branch=<branch_name>] [--skip-bin] [--log=<log_file>]
pyrevit clone <clone_name> --image=<image_url> [--dest=<dest_path>] [--skip-bin] [--log=<log_file>]
pyrevit clone <clone_name> [--dest=<dest_path>] [--source=<repo_url>] [--branch=<branch_name>] [--skip-bin] [--log=<log_file>] [(--username=<username> --password=<password> | --token=<auth_token>)]

clones

pyrevit clones [(-h | --help)]
pyrevit clones (info | open) <clone_name>
pyrevit clones add this <clone_name> [--force] [--log=<log_file>]
pyrevit clones add <clone_name> <clone_path> [--force] [--log=<log_file>]
pyrevit clones forget (--all | <clone_name>) [--log=<log_file>]
pyrevit clones rename <clone_name> <clone_new_name> [--log=<log_file>]
pyrevit clones delete [(--all | <clone_name>)] [--clearconfigs] [--log=<log_file>]
pyrevit clones branch <clone_name> [<branch_name>] [--log=<log_file>]
pyrevit clones version <clone_name> [<tag_name>] [--log=<log_file>]
pyrevit clones commit <clone_name> [<commit_hash>] [--log=<log_file>]
pyrevit clones origin <clone_name> --reset [--log=<log_file>]
pyrevit clones origin <clone_name> [<origin_url>] [--log=<log_file>]
pyrevit clones update (--all | <clone_name>) [--skip-bin] [--log=<log_file>] [(--username=<username> --password=<password> | --token=<auth_token>)]
pyrevit clones deployments <clone_name>
pyrevit clones engines <clone_name>

attach

pyrevit attach (-h | --help)
pyrevit attach <clone_name> (default | <engine_version>) (<revit_year> | --installed | --attached) [--allusers] [--log=<log_file>]

attached

pyrevit attached [<revit_year>] [(-h | --help)]

switch

pyrevit switch (-h | --help)
pyrevit switch <clone_name> [<revit_year>]

detach

pyrevit detach (-h | --help)
pyrevit detach (--all | <revit_year>) [--log=<log_file>]

extend

pyrevit extend (-h | --help)
pyrevit extend <extension_name> [--dest=<dest_path>] [--branch=<branch_name>] [--log=<log_file>]
pyrevit extend (ui | lib) <extension_name> <repo_url> [--dest=<dest_path>] [--branch=<branch_name>] [--log=<log_file>] [(--username=<username> --password=<password> | --token=<auth_token>)] [--persist-credentials]

extensions

pyrevit extensions [(-h | --help)]
pyrevit extensions search <search_pattern>
pyrevit extensions (info | help ) <extension_name>
pyrevit extensions open <extension_name>
pyrevit extensions open <clone_name> <extension_name>
pyrevit extensions delete <extension_name> [--log=<log_file>]
pyrevit extensions origin <extension_name> --reset [--log=<log_file>]
pyrevit extensions origin <extension_name> [<origin_url>] [--log=<log_file>]
pyrevit extensions paths [(-h | --help)]
pyrevit extensions paths forget --all [--log=<log_file>]
pyrevit extensions paths (add | forget) <extensions_path> [--log=<log_file>]
pyrevit extensions (enable | disable) <extension_name> [--log=<log_file>]
pyrevit extensions (enable | disable) <clone_name> <extension_name> [--log=<log_file>]
pyrevit extensions sources [(-h | --help)]
pyrevit extensions sources forget --all [--log=<log_file>]
pyrevit extensions sources (add | forget) <source_json_or_url> [--log=<log_file>]
pyrevit extensions update (--all | <extension_name>) [--log=<log_file>] [(--username=<username> --password=<password> | --token=<auth_token>)]

releases

pyrevit releases (-h | --help)
pyrevit releases [--pre] [--notes]
pyrevit releases latest [--pre] [--notes]
pyrevit releases <search_pattern> [--pre] [--notes]
pyrevit releases open latest [--pre]
pyrevit releases open <search_pattern> [--pre]
pyrevit releases download installer latest [--dest=<dest_path>] [--pre] [--admin]
pyrevit releases download installer <search_pattern> [--dest=<dest_path>] [--pre] [--admin]
pyrevit releases download archive latest [--dest=<dest_path>] [--pre]
pyrevit releases download archive <search_pattern> [--dest=<dest_path>] [--pre]

revits

pyrevit revits
pyrevit revits (-h | --help)
pyrevit revits [--installed] [--log=<log_file>]
pyrevit revits --supported [--csv=<output_file>]
pyrevit revits killall [<revit_year>] [--log=<log_file>]
pyrevit revits fileinfo <file_or_dir_path> [--csv=<output_file>] [--rvt] [--rte] [--rfa] [--rft]

run

pyrevit run (-h | --help)
pyrevit run commands
pyrevit run <script_or_command_name> [--revit=<revit_year>] [--purge] [--allowdialogs] [--import=<import_path>]
pyrevit run <script_or_command_name> --models=<model_list_file> --revit=<revit_year> [--purge] [--allowdialogs] [--import=<import_path>]
pyrevit run <script_or_command_name> <model_file> [--revit=<revit_year>] [--purge] [--allowdialogs] [--import=<import_path>]

launch

pyrevit launch (-h | --help)
pyrevit launch <clone_name_or_path> (default | <engine_version>) <revit_year> [<model_file>] [--isolated] [--language=<code>] [--log=<log_file>]

agent

pyrevit agent (-h | --help)
pyrevit agent status [--json]
pyrevit agent context [--revit=<revit_year>]
pyrevit agent run <script_file> [--mode=<run_mode>] [--engine=<engine_name>] [--title=<run_title>] [--inputs=<inputs_json>] [--revit=<revit_year>] [--timeout=<seconds>] [--workspace=<folder>]
pyrevit agent runs [--limit=<count>]
pyrevit agent show <run_id>

mcp

pyrevit mcp (-h | --help)
pyrevit mcp [--revit=<revit_year>]
pyrevit mcp install (claude | codex | cursor | vscode | opencode) [--project] [--log=<log_file>]
pyrevit mcp uninstall (claude | codex | cursor | vscode | opencode) [--project] [--log=<log_file>]
pyrevit mcp uninstall --all [--owned] [--log=<log_file>]

caches

pyrevit caches (-h | --help)
pyrevit caches [bim360] clear (--all | <revit_year>) [--log=<log_file>]

config

pyrevit config (-h | --help)
pyrevit config --from=<template_config_path> [--log=<log_file>]

configs

pyrevit configs (-h | --help)
pyrevit configs bincache [(enable | disable)] [--log=<log_file>]
pyrevit configs checkupdates [(enable | disable)] [--log=<log_file>]
pyrevit configs autoupdate [(enable | disable)] [--log=<log_file>]
pyrevit configs rocketmode [(enable | disable)] [--log=<log_file>]
pyrevit configs logs [(none | verbose | debug)] [--log=<log_file>]
pyrevit configs filelogging [(enable | disable)] [--log=<log_file>]
pyrevit configs startuptimeout [<timeout>] [--log=<log_file>]
pyrevit configs loadbeta [(enable | disable)] [--log=<log_file>]
pyrevit configs cpyversion [<cpy_version>] [--log=<log_file>]
pyrevit configs usercanupdate [(yes | no)] [--log=<log_file>]
pyrevit configs usercanextend [(yes | no)] [--log=<log_file>]
pyrevit configs usercanconfig [(yes | no)] [--log=<log_file>]
pyrevit configs colordocs [(enable | disable)] [--log=<log_file>]
pyrevit configs tooltipdebuginfo [(enable | disable)] [--log=<log_file>]
pyrevit configs routes [(-h | --help)]
pyrevit configs routes [(enable | disable)] [--log=<log_file>]
pyrevit configs routes port [<port_number>] [--log=<log_file>]
pyrevit configs routes coreapi [(enable | disable)] [--log=<log_file>]
pyrevit configs agent [(-h | --help)]
pyrevit configs agent [(enable | disable)] [--log=<log_file>]
pyrevit configs agent policy [(readonly | ask | auto)] [--log=<log_file>]
pyrevit configs agent engine [(ironpython | cpython)] [--log=<log_file>]
pyrevit configs agent skills [(enable | disable)] [--log=<log_file>]
pyrevit configs agent reckless [(enable | disable)] [--log=<log_file>]
pyrevit configs telemetry [(-h | --help)]
pyrevit configs telemetry [(enable | disable)] [--log=<log_file>]
pyrevit configs telemetry utc [(yes | no)] [--log=<log_file>]
pyrevit configs telemetry (file | server) [<dest_path>] [--log=<log_file>]
pyrevit configs telemetry hooks [(yes | no)] [--log=<log_file>]
pyrevit configs apptelemetry [(enable | disable)] [--log=<log_file>]
pyrevit configs apptelemetry flags [<flags>] [--log=<log_file>]
pyrevit configs apptelemetry server [<server_path>] [--log=<log_file>]
pyrevit configs outputcss [<css_path>] [--log=<log_file>]
pyrevit configs seed [--lock] [--log=<log_file>]
pyrevit configs seedshippeddefaults [--log=<log_file>]
pyrevit configs <option_path> [(enable | disable)] [--log=<log_file>]
pyrevit configs <option_path> [<option_value>] [--log=<log_file>]

doctor

pyrevit doctor (-h | --help)
pyrevit doctor [--list]
pyrevit doctor <doctor_command> [--dryrun]