日本語

misskey-hs

A Haskell library for syuilo/Misskey's API

Usage

As CLI tool

Prepare Config

Firstly, Please make config file at $HOME/.config/misskey-hs/config.yaml with format:

token: <your_token>
instance_url: <your_instance_url>

i.e. if you have token "MYTOKENHERE" and you're living in "misskey.io"

token: MYTOKENHERE
instance_url: misskey.io

Command usage

stack run -- to call each API.
Specify API by subcommand, and pass args by options.
stack run -- --help to more help.

Usage sample

$ stack run -- users/show --username cj_bc_sd
[User {_user_id = ...}]

$ stack run -- --help
Usage: misskey-hs-exe COMMAND
  call Misskey API

Available options:
  -h,--help                Show this help text

Available commands:
  users/show               call users/show API
  users/notes              call users/notes API
  users/search             call users/search API
  users                    call users API

As Library

This package adds modules below:

module	description
Web.Misskey.Type	Provide types for general usage
Web.Misskey.Api.Users.Show	Command and APIRequest for users/show
Web.Misskey.Api.Users.Search	Command and APIRequest for users/search
Web.Misskey.Api.Users.Notes	Command and APIRequest for users/Notes
Web.Misskey.Api.Users.Users	Command and APIRequest for users
Web.Misskey.Api.Users.Following	Command and APIRequest for `users/following
Web.Misskey.Api.Users.Followers	Command and APIRequest for `users/followers
Web.Misskey.Api.Notes.Create	Command and APIRequest for notes/create
Web.Misskey.Api.Notes.Timeline	Command and APIRequest for notes/timeline

Basic usage

All API-calling functions are placed in Web.Misskey.Api.*
You can pick one(e.g. usersShow), give it APIRequest(defined in each module), and do runMisskey with MisskeyEnv to send API request.

e.g. Sending users/show API request to me([email protected]), and print result.

import Web.Misskey.Api.Users.Show (usersShow, APIRequest(..))
import Web.Misskey.Type (User(..), MisskeyEnv(..))


main :: IO ()
main = do
    let env = MisskeyEnv ""                -- A Misskey token. I omit this because we don't need it in this time
                         "virtual-kaf.fun" -- Domain which to send API request
        req = UserName "cj_bc_sd"          -- `UserName` is value constructor of APIRequest (for `usersShow`)

    -- Post API Request and get result
    usr <- runMisskey (usersShow req) env

    print usr

See haddock and misskey's api document(Currently lacks some data)