changelist-protocol

Changelist Protocol Documentation

Built-in Server Rest API

URL Scheme Usage

The base URL is jetbrains://<IDE ID>/changelist/<target>

Known IDE IDs

Known identifiers for each JetBrains IDE. These are the first element in the URL path. Those marked as unknown are have not been checked, but are probably the IDE name in lower-case. Those that are none have been attempted and not responded to any probable IDs.

IDE	Identifier
Aqua	unknown
CLion	`clion`
~~DataGrip~~	none
DataSpell	unknown
Fleet	unknown
~~Gateway~~	none
GoLand	`goland`
IntelliJ IDEA	`idea`
PhpStorm	`php-storm`
PyCharm	`pycharm`
Rider	`rider`
RubyMine	`rubymine`
~~RustRover~~	none
WebStorm	`webstorm`

Available Targets

New Changelist

Example

open jetbrains://idea/changelist/add?project=changelist-protocol&name=Actual%20Changelist&comment=Test%20comment

Parameter	Required	Type	Description
`project`	Yes	string	Project to create the changelist in
`name`	Yes	string	Changelist name
`comment`	No	string	Changelist comment
`active`	No	boolean	Whether to make new changelist the active one (default: true)

Set Active Changelist

Example

open jetbrains://pycharm/changelist/activate?project=changelist-protocol&name=New%20changelist

Parameter	Required	Type	Description
`project`	Yes	string	Changelist’s project
`name`	Yes, unless `default` is `true`	string	Changelist name
`default`	No	boolean	Active the default changelist

Update Changelist

Example

open jetbrains://pycharm/changelist/update?project=changelist-protocol&name=New%20changelist&comment=Editted%20comment

Parameter	Required	Type	Description
`project`	Yes	string	Changelist’s project
`name`	Yes	string	Changelist name
`new-name`	No	string	Rename Changelist to this name
`active`	No	boolean	Whether to make changelist the active one
`comment`	No	string	Changelist comment

Delete Changelist

Example

open jetbrains://goland/changelist/remove?project=changelist-protocol&name=Actual%20Changelist

Parameter	Required	Type	Description
`project`	Yes	string	Changelist’s project
`name`	Yes	string	Changelist name

X-Callback

Supports https://x-callback-url.com callback URLs. If provided, x-success or x-error will be invoked as appropriate.

This site is open source. Improve this page.