Command Glossary

Command Glossary

After installing syntropycli Python package syntropyctl command should be available. In case it is not, you can use python -m syntropycli instead.

$ syntropyctl --help
Usage: syntropyctl [OPTIONS] COMMAND [ARGS]...

  Syntropy Networks Command Line Interface.

  --help  Show this message and exit.

  configure-endpoints       Configures an endpoint with provided provider,...
  create-api-key            Create a API key for endpoint agent.
  create-connections        Create connections between endpoints.
  delete-api-key            Delete API key either by name or by id.
  delete-connection         Delete a connection.
  get-api-keys              List all API keys.
  get-connections           Retrieves network connections.
  get-endpoints             List all endpoints.
  get-providers             Retrieve a list of endpoint providers.