Skip to content

CLI usage

We provide a CLI that allows users to link their projects with the Kyn platform.

Authentication

We want the integration with existing projects to be as frictionless as possible while also respecting user privacy, so we are currently considering using wallets for authentication.

> kyn auth <address>

This command will generate a URL that the user must visit to verify that they own the provided wallet. After the wallet is successfuly verified, an API key will be displayed, which can be set in a .env file or passed as a parameter to the other CLI commands.

Registering Handlers

The kyn register command is used to register or update handlers. The command is used as follows:

> kyn register <contract name>:<handler identifier> [setUp args]...

This will upload the contract sources to Kyn, and Kyn's backend will compile the contract and run the setUp function. An instance of the handler will begin running at that point.

If a handler with the same <handler identifier> already exists, it will be replaced. It is still TBD how to manage the existing handler functions that might have been registered outside of the setUp function.