Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Plugin registry

proto's registry is currently powered by static JSON files located in the registry/data directory.

In the future, we plan to build and host an actual server based registry, in which all plugin artifacts are stored. Until then, this works quite well.

Publishing a plugin

Since we don't have a database, to make a plugin available to the community (via proto plugin search), you'll need to modify the registry/data/third-party.json JSON file.

Simply add an entry to the array with your relevant information. View this TypeScript interface for available fields, and which are required.

{
  "plugins": [
    // ...
    {
      "id": "my-new-tool"
      // ...
    }
  ]
}

Once your entry has been added, you can validate and format the dataset with the following command. If you don't have just or cargo installed, no worries, CI will validate it for you.

# With just
$ just gen

# With cargo/rust
$ cargo run -p proto_codegen

Then commit your changes and create a pull request. Once merged, your plugin will start showing up in search results!