Finding Extensions

pyrevit extensions search <search_pattern>
pyrevit extensions (info | help | open) <extension_name>

$ pyrevit extensions search apex    # search for an extension with apex in name
$ pyrevit extensions info apex      # get info on extension with apex in name

• <search_pattern>: Regular Expression (REGEX) pattern to search for

Installing Extensions

pyrevit extend <extension_name> [--dest=<dest_path>] [--branch=<branch_name>] [--log=<log_file>]

$ pyrevit extend pyApex "C:\\pyRevit\\Extensions"     # install pyApex extension

• --dest: This is optional. If not provided, pyRevit attempts to install extension at the defautl third-party extension folder (usually %appdata%/pyRevit/Extensions). The destination directory will be added to pyRevit extensions search paths automatically and will be loaded on the next pyRevit reload.
• --branch: Optional. Specific branch of the extension repo to be installed. Defaults to master branch if not provided.

To installing your own extensions, you’ll need to specify what type if extension you’re installing (ui or lib) and provide the url:

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

$ pyrevit extend ui MyExtension "<https://www.github.com/my-extension.git>" "C:\\pyRevit\\Extensions"

<aside> ⚠️ Preferred: --token=<token> use a fine grained token with proper scope

</aside>

<aside> ⚠️ Deprecated in Github: If you are cloning your extension from a private repository, you can provide the --username and --password to the repo account as well.

</aside>

Managing Installed Extensions

List all installed extensions:

pyrevit extensions

Delete an extension completely using:

pyrevit extensions delete <extension_name> [--log=<log_file>]

$ pyrevit extensions delete pyApex

Set origin url on an extension using:

pyrevit extensions origin <extension_name> --reset [--log=<log_file>]
pyrevit extensions origin <extension_name> [<origin_url>] [--log=<log_file>]

$ # changing origin remote url for `pyApex` extension
$ pyrevit extensions origin pyApex <https://www.git.com/repo.git>  

$ # resetting origin remote url back to default for `pyApex` extension
$ pyrevit extensions origin pyApex --reset

Add, remove extension search paths for all your existing extensions:

pyrevit extensions paths
pyrevit extensions paths forget --all [--log=<log_file>]
pyrevit extensions paths (add | forget) <extensions_path> [--log=<log_file>]

$ pyrevit extensions paths add "C:\\pyRevit\\MyExtensions"    # add a search path
$ pyrevit extensions paths forget --all         # forget all search paths