aboutsummaryrefslogtreecommitdiffstats
path: root/adenosine-cli/plan.txt
blob: fc7b6dc639a4d6cb5947cd918897304c2240553f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

CLI name is `adenosine`.

This is (for now) a "light" or "delegated" client which has no local state and
just talks to the remote.

config variables:

    ATP_SERVICE: prefix, eg http://localhost:1234
    ATP_AUTH_TOKEN: JWT string

at-uri can be either a global `at://` URI string, or a user-local referene of
the form <collection>/<TID>.

like in httpie, params can be '=' for a JSON field assignment; '==' for query
parameters (though there are usually CLI args instead); '@' to import a JSON
file; '-' to read a JSON file from stdin.

    get <at-uri>
    ls <at-uri>?

    create <collection> <params>+
    update <at-uri> <params>+
    delete <at-uri>

    describe <name|did>
    resolve <name|did> => output DID doc (optionally do this directly?)

    validate <nsid> <params>+

    status
        => status of configuration, registration, logged in, current did/username (from JWT?), etc

    account
        register
        delete
        login
        logout
        info <name>?
        create-revocation-key

    repo
        root
        export <at-uri>?
        import <in-cbor-filename> [--from <cid>]

    xrpc get|post <nsid> [<params>]+
        => generic method

    bsky
        feed <name>?
        notifications

        post [<params>]+
        repost <at-uri>
        like <at-uri>
        unlike <at-uri>
        follow <name|did>
        unfollow <name|did>

        follows <name|did>?
        followers <name|did>?
        profile <name>?
        search-users <query>