/ 
App-MatrixTool-0.08
River stage zero No dependents
/ matrixtool

NAME

matrixtool - commands to interact with a Matrix home-server

SYNOPSIS

$ matrixtool server-key matrix.org

DESCRIPTION

This command provides a wrapper around a number of sub-commands that provide useful interactions with a Matrix home-server.

The individual sub-commands are listed below:

COMMANDS

client

Commandline client utilities

$ matrixtool client COMMAND [...]

Options:

  • --server (-s)

    Server

  • --user-id (-u)

    User ID

  • --user-id-parameter (-U)

    'user_id' query parameter override

See also App::MatrixTool::Command::client.

client json

Perform a direct JSON request

$ matrixtool client json PATH [DATA]

Options:

  • --method (-m)

    HTTP method

See also App::MatrixTool::Command::client::json.

client list-rooms

List the rooms the user is in

$ matrixtool client list-rooms

See also App::MatrixTool::Command::client::list_rooms.

client login

Obtain a client authentication token

$ matrixtool client login USER [PASSWORD]

See also App::MatrixTool::Command::client::login.

client sync

Follow the /sync event stream

$ matrixtool client sync

Options:

  • --initial (-i)

    Print the initial sync result too

See also App::MatrixTool::Command::client::sync.

client upload

Upload a file to the media repository

$ matrixtool client upload FILE [TYPE]

See also App::MatrixTool::Command::client::upload.

directory

Look up room alias to room ID entries

$ matrixtool directory ALIAS

Options:

  • --servers (-s)

    Include list of candidate servers

See also App::MatrixTool::Command::directory.

help

Display help information about commands

$ matrixtool help [COMMAND...]

See also App::MatrixTool::Command::help.

notary

Fetch a server's signing key via another server

$ matrixtool notary SERVER-NAME VIA

See also App::MatrixTool::Command::notary.

resolve

Look up hostnames or IP addresses of a server

$ matrixtool resolve SERVER-NAME

Options:

  • --address (-a)

    Resolve hostnames into IP addressese

See also App::MatrixTool::Command::resolve.

server-key

Fetch a server's signing key

$ matrixtool server-key SERVER-NAME

Options:

  • --no-store (-n)

    Don't cache the received key in the key store

  • --v1 (-1)

    Restrict to the v1 key API

  • --v2 (-2)

    Restrict to the v2 key API

See also App::MatrixTool::Command::server_key.

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>