commit bf554355c52c2c9214c26a8dddbc92201d311014 · anil.recoil.org/slop

+275

stack/karakeepe/README.md

···

       1
       +
       # Karakeepe - Karakeep/Hoarder CLI Client

     

       2
       +
       

     

       3
       +
       A command-line client for managing bookmarks in [Karakeep (Hoarder)](https://github.com/hoarder-app/hoarder).

     

       4
       +
       

     

       5
       +
       ## Features

     

       6
       +
       

     

       7
       +
       - 🔖 List, search, and manage bookmarks

     

       8
       +
       - 🔐 Secure credential storage using [keyeio](../keyeio)

     

       9
       +
       - 📁 Multiple profile support (default, production, staging, etc.)

     

       10
       +
       - 🎯 Tag-based filtering and search

     

       11
       +
       - ⭐ Support for favourites and archived bookmarks

     

       12
       +
       - 📝 Add notes and titles to bookmarks

     

       13
       +
       

     

       14
       +
       ## Installation

     

       15
       +
       

     

       16
       +
       ```bash

     

       17
       +
       opam install karakeepe

     

       18
       +
       ```

     

       19
       +
       

     

       20
       +
       ## Configuration

     

       21
       +
       

     

       22
       +
       Create a configuration file at `~/.config/karakeepe/keys/karakeepe.toml`:

     

       23
       +
       

     

       24
       +
       ```toml

     

       25
       +
       [default]

     

       26
       +
       api_key = "ak1_<key_id>_<secret>"

     

       27
       +
       base_url = "https://hoard.example.com"

     

       28
       +
       

     

       29
       +
       [production]

     

       30
       +
       api_key = "ak1_<prod_key_id>_<prod_secret>"

     

       31
       +
       base_url = "https://hoard.prod.example.com"

     

       32
       +
       ```

     

       33
       +
       

     

       34
       +
       ### Getting an API Key

     

       35
       +
       

     

       36
       +
       1. Log in to your Karakeep instance

     

       37
       +
       2. Navigate to Settings → API Keys

     

       38
       +
       3. Create a new API key

     

       39
       +
       4. Copy the key (format: `ak1_<key_id>_<secret>`)

     

       40
       +
       

     

       41
       +
       ## Usage

     

       42
       +
       

     

       43
       +
       ### List Bookmarks

     

       44
       +
       

     

       45
       +
       ```bash

     

       46
       +
       # List all bookmarks

     

       47
       +
       karakeepe list

     

       48
       +
       

     

       49
       +
       # List with limit

     

       50
       +
       karakeepe list --limit 10

     

       51
       +
       

     

       52
       +
       # List only archived bookmarks

     

       53
       +
       karakeepe list --archived true

     

       54
       +
       

     

       55
       +
       # List only favourited bookmarks

     

       56
       +
       karakeepe list --favourited true

     

       57
       +
       

     

       58
       +
       # Filter by tags

     

       59
       +
       karakeepe list --tags "work,important"

     

       60
       +
       

     

       61
       +
       # Use production profile

     

       62
       +
       karakeepe list --profile production

     

       63
       +
       ```

     

       64
       +
       

     

       65
       +
       ### Get a Single Bookmark

     

       66
       +
       

     

       67
       +
       ```bash

     

       68
       +
       # Get bookmark by ID

     

       69
       +
       karakeepe get <bookmark-id>

     

       70
       +
       

     

       71
       +
       # Example

     

       72
       +
       karakeepe get "clx7y8z9a0001..."

     

       73
       +
       ```

     

       74
       +
       

     

       75
       +
       ### Create a Bookmark

     

       76
       +
       

     

       77
       +
       ```bash

     

       78
       +
       # Create a simple bookmark

     

       79
       +
       karakeepe create "https://example.com"

     

       80
       +
       

     

       81
       +
       # Create with title

     

       82
       +
       karakeepe create "https://example.com" --title "Example Site"

     

       83
       +
       

     

       84
       +
       # Create with title and tags

     

       85
       +
       karakeepe create "https://example.com" \

     

       86
       +
         --title "Example Site" \

     

       87
       +
         --tags "web,example,reference"

     

       88
       +
       

     

       89
       +
       # Create with note

     

       90
       +
       karakeepe create "https://example.com" \

     

       91
       +
         --title "Example" \

     

       92
       +
         --note "Useful reference for web development"

     

       93
       +
       

     

       94
       +
       # Create as favourited

     

       95
       +
       karakeepe create "https://example.com" --favourited

     

       96
       +
       

     

       97
       +
       # Create as archived

     

       98
       +
       karakeepe create "https://example.com" --archived

     

       99
       +
       ```

     

       100
       +
       

     

       101
       +
       ### Search Bookmarks

     

       102
       +
       

     

       103
       +
       ```bash

     

       104
       +
       # Search by single tag

     

       105
       +
       karakeepe search --tags work

     

       106
       +
       

     

       107
       +
       # Search by multiple tags

     

       108
       +
       karakeepe search --tags "work,important"

     

       109
       +
       

     

       110
       +
       # Limit search results

     

       111
       +
       karakeepe search --tags work --limit 5

     

       112
       +
       ```

     

       113
       +
       

     

       114
       +
       ## Command Reference

     

       115
       +
       

     

       116
       +
       ### Global Options

     

       117
       +
       

     

       118
       +
       - `--profile NAME` - Select profile to use (default: "default")

     

       119
       +
       - `--key-file FILE` - Override with direct TOML file path

     

       120
       +
       - `--url URL` - Override base URL from profile

     

       121
       +
       - `--help` - Show help for command

     

       122
       +
       

     

       123
       +
       ### Commands

     

       124
       +
       

     

       125
       +
       #### `karakeepe list [OPTIONS]`

     

       126
       +
       

     

       127
       +
       List bookmarks with optional filtering.

     

       128
       +
       

     

       129
       +
       **Options:**

     

       130
       +
       - `-l, --limit NUM` - Maximum number of bookmarks to fetch (default: 50)

     

       131
       +
       - `-a, --archived BOOL` - Filter by archived status (true/false)

     

       132
       +
       - `-f, --favourited BOOL` - Filter by favourited status (true/false)

     

       133
       +
       - `-t, --tags TAGS` - Filter by tags (comma-separated)

     

       134
       +
       

     

       135
       +
       #### `karakeepe get ID`

     

       136
       +
       

     

       137
       +
       Get detailed information for a single bookmark.

     

       138
       +
       

     

       139
       +
       **Arguments:**

     

       140
       +
       - `ID` - Bookmark ID (required)

     

       141
       +
       

     

       142
       +
       #### `karakeepe create URL [OPTIONS]`

     

       143
       +
       

     

       144
       +
       Create a new bookmark.

     

       145
       +
       

     

       146
       +
       **Arguments:**

     

       147
       +
       - `URL` - URL to bookmark (required)

     

       148
       +
       

     

       149
       +
       **Options:**

     

       150
       +
       - `--title TITLE` - Bookmark title

     

       151
       +
       - `-n, --note NOTE` - Bookmark note/description

     

       152
       +
       - `-t, --tags TAGS` - Tags to add (comma-separated)

     

       153
       +
       - `-a, --archived` - Mark as archived

     

       154
       +
       - `-f, --favourited` - Mark as favourited

     

       155
       +
       

     

       156
       +
       #### `karakeepe search --tags TAGS [OPTIONS]`

     

       157
       +
       

     

       158
       +
       Search bookmarks by tags.

     

       159
       +
       

     

       160
       +
       **Options:**

     

       161
       +
       - `-t, --tags TAGS` - Tags to search for (comma-separated, required)

     

       162
       +
       - `-l, --limit NUM` - Maximum number of results (default: 50)

     

       163
       +
       

     

       164
       +
       ## Examples

     

       165
       +
       

     

       166
       +
       ### Daily Workflow

     

       167
       +
       

     

       168
       +
       ```bash

     

       169
       +
       # Add a bookmark you found

     

       170
       +
       karakeepe create "https://blog.example.com/article" \

     

       171
       +
         --title "Great Article on OCaml" \

     

       172
       +
         --tags "ocaml,programming,blog"

     

       173
       +
       

     

       174
       +
       # List your work bookmarks

     

       175
       +
       karakeepe list --tags work

     

       176
       +
       

     

       177
       +
       # Search for OCaml resources

     

       178
       +
       karakeepe search --tags ocaml

     

       179
       +
       

     

       180
       +
       # Get details of a specific bookmark

     

       181
       +
       karakeepe get clx7y8z9a0001...

     

       182
       +
       

     

       183
       +
       # Mark something as favourited

     

       184
       +
       karakeepe create "https://important.example.com" --favourited

     

       185
       +
       ```

     

       186
       +
       

     

       187
       +
       ### Multiple Profiles

     

       188
       +
       

     

       189
       +
       ```bash

     

       190
       +
       # Use default profile (personal instance)

     

       191
       +
       karakeepe list

     

       192
       +
       

     

       193
       +
       # Use work profile

     

       194
       +
       karakeepe list --profile work

     

       195
       +
       

     

       196
       +
       # Use custom file

     

       197
       +
       karakeepe list --key-file ~/my-keys.toml --profile custom

     

       198
       +
       ```

     

       199
       +
       

     

       200
       +
       ## Profile Setup Examples

     

       201
       +
       

     

       202
       +
       ### Personal Setup

     

       203
       +
       

     

       204
       +
       `~/.config/karakeepe/keys/karakeepe.toml`:

     

       205
       +
       ```toml

     

       206
       +
       [default]

     

       207
       +
       api_key = "ak1_abc123..."

     

       208
       +
       base_url = "https://hoard.example.com"

     

       209
       +
       ```

     

       210
       +
       

     

       211
       +
       ### Work Setup

     

       212
       +
       

     

       213
       +
       `~/.config/karakeepe/keys/karakeepe.toml`:

     

       214
       +
       ```toml

     

       215
       +
       [default]

     

       216
       +
       api_key = "ak1_personal_key..."

     

       217
       +
       base_url = "https://hoard.personal.com"

     

       218
       +
       

     

       219
       +
       [work]

     

       220
       +
       api_key = "ak1_work_key..."

     

       221
       +
       base_url = "https://hoard.company.com"

     

       222
       +
       ```

     

       223
       +
       

     

       224
       +
       ## Library Usage

     

       225
       +
       

     

       226
       +
       The `karakeepe` library can also be used programmatically in OCaml applications:

     

       227
       +
       

     

       228
       +
       ```ocaml

     

       229
       +
       let () =

     

       230
       +
         Eio_main.run @@ fun env ->

     

       231
       +
         Eio.Switch.run @@ fun sw ->

     

       232
       +
       

     

       233
       +
         let api_key = "ak1_..." in

     

       234
       +
         let base_url = "https://hoard.example.com" in

     

       235
       +
       

     

       236
       +
         (* Fetch all bookmarks *)

     

       237
       +
         let bookmarks = Karakeepe.fetch_all_bookmarks

     

       238
       +
           ~sw ~env ~api_key base_url in

     

       239
       +
       

     

       240
       +
         (* Create a bookmark *)

     

       241
       +
         let bookmark = Karakeepe.create_bookmark

     

       242
       +
           ~sw ~env ~api_key

     

       243
       +
           ~url:"https://example.com"

     

       244
       +
           ~title:"Example"

     

       245
       +
           ~tags:["web"; "example"]

     

       246
       +
           base_url in

     

       247
       +
       

     

       248
       +
         Printf.printf "Created bookmark: %s\n" bookmark.id

     

       249
       +
       ```

     

       250
       +
       

     

       251
       +
       See the [library documentation](karakeepe.mli) for full API reference.

     

       252
       +
       

     

       253
       +
       ## Troubleshooting

     

       254
       +
       

     

       255
       +
       ### "Service file not found: karakeepe.toml"

     

       256
       +
       

     

       257
       +
       Create the configuration file at `~/.config/karakeepe/keys/karakeepe.toml` with your API key.

     

       258
       +
       

     

       259
       +
       ### "HTTP error: 401"

     

       260
       +
       

     

       261
       +
       Your API key is invalid or expired. Generate a new one from your Karakeep instance.

     

       262
       +
       

     

       263
       +
       ### "HTTP error: 404"

     

       264
       +
       

     

       265
       +
       The bookmark ID doesn't exist or the base URL is incorrect.

     

       266
       +
       

     

       267
       +
       ## See Also

     

       268
       +
       

     

       269
       +
       - [Hoarder](https://github.com/hoarder-app/hoarder) - The Karakeep/Hoarder bookmark manager

     

       270
       +
       - [keyeio](../keyeio) - Secure API key storage

     

       271
       +
       - [xdge](../xdge) - XDG Base Directory Specification for Eio

     

       272
       +
       

     

       273
       +
       ## License

     

       274
       +
       

     

       275
       +
       ISC License

stack/karakeepe/bin/dune

···

       1
       +
       (executable

     

       2
       +
        (name karakeepe_cli)

     

       3
       +
        (public_name karakeepe)

     

       4
       +
        (libraries karakeepe keyeio xdge eiocmd eio eio_main cmdliner ptime))

+379

stack/karakeepe/bin/karakeepe_cli.ml

···

       1
       +
       open Cmdliner

     

       2
       +
       

     

       3
       +
       (** List bookmarks command *)

     

       4
       +
       let list_bookmarks env _xdg profile base_url limit archived favourited tags =

     

       5
       +
         Eio.Switch.run @@ fun sw ->

     

       6
       +
       

     

       7
       +
         let api_key = Keyeio.Profile.get_required profile ~key:"api_key" in

     

       8
       +
         let base_url =

     

       9
       +
           match base_url with

     

       10
       +
           | Some url -> url

     

       11
       +
           | None ->

     

       12
       +
               Keyeio.Profile.get profile ~key:"base_url"

     

       13
       +
               |> Option.value ~default:"https://hoard.recoil.org"

     

       14
       +
         in

     

       15
       +
       

     

       16
       +
         Printf.printf "Fetching bookmarks from %s...\n" base_url;

     

       17
       +
       

     

       18
       +
         try

     

       19
       +
           let bookmarks = Karakeepe.fetch_all_bookmarks

     

       20
       +
             ~sw ~env ~api_key

     

       21
       +
             ~page_size:limit

     

       22
       +
             ~include_content:true

     

       23
       +
             ?filter_tags:(if tags = [] then None else Some tags)

     

       24
       +
             base_url

     

       25
       +
           in

     

       26
       +
       

     

       27
       +
           (* Filter by archived/favourited if requested *)

     

       28
       +
           let bookmarks =

     

       29
       +
             List.filter (fun (b : Karakeepe.bookmark) ->

     

       30
       +
               (match archived with

     

       31
       +
                | Some true -> b.archived

     

       32
       +
                | Some false -> not b.archived

     

       33
       +
                | None -> true) &&

     

       34
       +
               (match favourited with

     

       35
       +
                | Some true -> b.favourited

     

       36
       +
                | Some false -> not b.favourited

     

       37
       +
                | None -> true)

     

       38
       +
             ) bookmarks

     

       39
       +
           in

     

       40
       +
       

     

       41
       +
           Printf.printf "Found %d bookmarks\n\n" (List.length bookmarks);

     

       42
       +
       

     

       43
       +
           List.iteri (fun i (b : Karakeepe.bookmark) ->

     

       44
       +
             Printf.printf "%d. %s\n" (i + 1) b.url;

     

       45
       +
             (match b.title with

     

       46
       +
              | Some title -> Printf.printf "   Title: %s\n" title

     

       47
       +
              | None -> ());

     

       48
       +
             Printf.printf "   ID: %s\n" b.id;

     

       49
       +
             Printf.printf "   Created: %s\n" (Ptime.to_rfc3339 b.created_at);

     

       50
       +
             if b.tags <> [] then

     

       51
       +
               Printf.printf "   Tags: %s\n" (String.concat ", " b.tags);

     

       52
       +
             if b.archived then Printf.printf "   [ARCHIVED]\n";

     

       53
       +
             if b.favourited then Printf.printf "   [FAVOURITED]\n";

     

       54
       +
             (match b.summary with

     

       55
       +
              | Some s when s <> "" ->

     

       56
       +
                  let summary = if String.length s > 100 then String.sub s 0 100 ^ "..." else s in

     

       57
       +
                  Printf.printf "   Summary: %s\n" summary

     

       58
       +
              | _ -> ());

     

       59
       +
             Printf.printf "\n"

     

       60
       +
           ) bookmarks;

     

       61
       +
           0

     

       62
       +
         with exn ->

     

       63
       +
           Printf.eprintf "Error: %s\n" (Printexc.to_string exn);

     

       64
       +
           1

     

       65
       +
       

     

       66
       +
       (** Get a single bookmark by ID *)

     

       67
       +
       let get_bookmark env _xdg profile base_url bookmark_id =

     

       68
       +
         Eio.Switch.run @@ fun sw ->

     

       69
       +
       

     

       70
       +
         let api_key = Keyeio.Profile.get_required profile ~key:"api_key" in

     

       71
       +
         let base_url =

     

       72
       +
           match base_url with

     

       73
       +
           | Some url -> url

     

       74
       +
           | None ->

     

       75
       +
               Keyeio.Profile.get profile ~key:"base_url"

     

       76
       +
               |> Option.value ~default:"https://hoard.recoil.org"

     

       77
       +
         in

     

       78
       +
       

     

       79
       +
         try

     

       80
       +
           let bookmark = Karakeepe.fetch_bookmark_details ~sw ~env ~api_key base_url bookmark_id in

     

       81
       +
       

     

       82
       +
           Printf.printf "Bookmark: %s\n" bookmark.url;

     

       83
       +
           Printf.printf "ID: %s\n" bookmark.id;

     

       84
       +
           (match bookmark.title with

     

       85
       +
            | Some title -> Printf.printf "Title: %s\n" title

     

       86
       +
            | None -> ());

     

       87
       +
           (match bookmark.note with

     

       88
       +
            | Some note -> Printf.printf "Note: %s\n" note

     

       89
       +
            | None -> ());

     

       90
       +
           Printf.printf "Created: %s\n" (Ptime.to_rfc3339 bookmark.created_at);

     

       91
       +
           (match bookmark.updated_at with

     

       92
       +
            | Some t -> Printf.printf "Updated: %s\n" (Ptime.to_rfc3339 t)

     

       93
       +
            | None -> ());

     

       94
       +
       

     

       95
       +
           if bookmark.tags <> [] then

     

       96
       +
             Printf.printf "Tags: %s\n" (String.concat ", " bookmark.tags);

     

       97
       +
       

     

       98
       +
           if bookmark.archived then Printf.printf "Status: ARCHIVED\n";

     

       99
       +
           if bookmark.favourited then Printf.printf "Status: FAVOURITED\n";

     

       100
       +
       

     

       101
       +
           (match bookmark.summary with

     

       102
       +
            | Some s when s <> "" -> Printf.printf "\nSummary:\n%s\n" s

     

       103
       +
            | _ -> ());

     

       104
       +
       

     

       105
       +
           if bookmark.content <> [] then begin

     

       106
       +
             Printf.printf "\nContent metadata:\n";

     

       107
       +
             List.iter (fun (k, v) ->

     

       108
       +
               if v <> "null" && v <> "" then

     

       109
       +
                 Printf.printf "  %s: %s\n" k v

     

       110
       +
             ) bookmark.content

     

       111
       +
           end;

     

       112
       +
       

     

       113
       +
           if bookmark.assets <> [] then begin

     

       114
       +
             Printf.printf "\nAssets:\n";

     

       115
       +
             List.iter (fun (id, asset_type) ->

     

       116
       +
               Printf.printf "  %s (%s)\n" id asset_type;

     

       117
       +
               Printf.printf "    URL: %s\n" (Karakeepe.get_asset_url base_url id)

     

       118
       +
             ) bookmark.assets

     

       119
       +
           end;

     

       120
       +
       

     

       121
       +
           0

     

       122
       +
         with exn ->

     

       123
       +
           Printf.eprintf "Error: %s\n" (Printexc.to_string exn);

     

       124
       +
           1

     

       125
       +
       

     

       126
       +
       (** Create a new bookmark *)

     

       127
       +
       let create_bookmark env _xdg profile base_url url title note tags archived favourited =

     

       128
       +
         Eio.Switch.run @@ fun sw ->

     

       129
       +
       

     

       130
       +
         let api_key = Keyeio.Profile.get_required profile ~key:"api_key" in

     

       131
       +
         let base_url =

     

       132
       +
           match base_url with

     

       133
       +
           | Some url -> url

     

       134
       +
           | None ->

     

       135
       +
               Keyeio.Profile.get profile ~key:"base_url"

     

       136
       +
               |> Option.value ~default:"https://hoard.recoil.org"

     

       137
       +
         in

     

       138
       +
       

     

       139
       +
         try

     

       140
       +
           Printf.printf "Creating bookmark: %s\n" url;

     

       141
       +
       

     

       142
       +
           let tags_opt = if tags = [] then None else Some tags in

     

       143
       +
       

     

       144
       +
           let bookmark = Karakeepe.create_bookmark

     

       145
       +
             ~sw ~env ~api_key

     

       146
       +
             ~url

     

       147
       +
             ?title

     

       148
       +
             ?note

     

       149
       +
             ?tags:tags_opt

     

       150
       +
             ~archived

     

       151
       +
             ~favourited

     

       152
       +
             base_url

     

       153
       +
           in

     

       154
       +
       

     

       155
       +
           Printf.printf "✓ Bookmark created successfully!\n";

     

       156
       +
           Printf.printf "ID: %s\n" bookmark.id;

     

       157
       +
           Printf.printf "URL: %s\n" bookmark.url;

     

       158
       +
           (match bookmark.title with

     

       159
       +
            | Some t -> Printf.printf "Title: %s\n" t

     

       160
       +
            | None -> ());

     

       161
       +
           if bookmark.tags <> [] then

     

       162
       +
             Printf.printf "Tags: %s\n" (String.concat ", " bookmark.tags);

     

       163
       +
           0

     

       164
       +
         with exn ->

     

       165
       +
           Printf.eprintf "Error: %s\n" (Printexc.to_string exn);

     

       166
       +
           1

     

       167
       +
       

     

       168
       +
       (** Search bookmarks by tag *)

     

       169
       +
       let search_bookmarks env __xdg profile base_url tags limit =

     

       170
       +
         Eio.Switch.run @@ fun sw ->

     

       171
       +
       

     

       172
       +
         let api_key = Keyeio.Profile.get_required profile ~key:"api_key" in

     

       173
       +
         let base_url =

     

       174
       +
           match base_url with

     

       175
       +
           | Some url -> url

     

       176
       +
           | None ->

     

       177
       +
               Keyeio.Profile.get profile ~key:"base_url"

     

       178
       +
               |> Option.value ~default:"https://hoard.recoil.org"

     

       179
       +
         in

     

       180
       +
       

     

       181
       +
         if tags = [] then begin

     

       182
       +
           Printf.eprintf "Error: At least one tag is required for search\n";

     

       183
       +
           1

     

       184
       +
         end else begin

     

       185
       +
           try

     

       186
       +
             Printf.printf "Searching for bookmarks with tags: %s\n" (String.concat ", " tags);

     

       187
       +
       

     

       188
       +
             let bookmarks = Karakeepe.fetch_all_bookmarks

     

       189
       +
               ~sw ~env ~api_key

     

       190
       +
               ~page_size:limit

     

       191
       +
               ~filter_tags:tags

     

       192
       +
               ~include_content:true

     

       193
       +
               base_url

     

       194
       +
             in

     

       195
       +
       

     

       196
       +
             Printf.printf "Found %d bookmarks\n\n" (List.length bookmarks);

     

       197
       +
       

     

       198
       +
             List.iteri (fun i (b : Karakeepe.bookmark) ->

     

       199
       +
               Printf.printf "%d. %s\n" (i + 1) b.url;

     

       200
       +
               (match b.title with

     

       201
       +
                | Some title -> Printf.printf "   Title: %s\n" title

     

       202
       +
                | None -> ());

     

       203
       +
               Printf.printf "   ID: %s\n" b.id;

     

       204
       +
               Printf.printf "   Tags: %s\n" (String.concat ", " b.tags);

     

       205
       +
               Printf.printf "\n"

     

       206
       +
             ) bookmarks;

     

       207
       +
             0

     

       208
       +
           with exn ->

     

       209
       +
             Printf.eprintf "Error: %s\n" (Printexc.to_string exn);

     

       210
       +
             1

     

       211
       +
         end

     

       212
       +
       

     

       213
       +
       (** Command-line arguments *)

     

       214
       +
       

     

       215
       +
       let base_url_arg =

     

       216
       +
         let doc = "Override Karakeep instance base URL" in

     

       217
       +
         Arg.(value & opt (some string) None & info ["url"; "u"] ~docv:"URL" ~doc)

     

       218
       +
       

     

       219
       +
       let limit_arg =

     

       220
       +
         let doc = "Maximum number of bookmarks to fetch" in

     

       221
       +
         Arg.(value & opt int 50 & info ["limit"; "l"] ~docv:"NUM" ~doc)

     

       222
       +
       

     

       223
       +
       let archived_arg =

     

       224
       +
         let doc = "Filter by archived status (true/false)" in

     

       225
       +
         Arg.(value & opt (some bool) None & info ["archived"; "a"] ~docv:"BOOL" ~doc)

     

       226
       +
       

     

       227
       +
       let favourited_arg =

     

       228
       +
         let doc = "Filter by favourited status (true/false)" in

     

       229
       +
         Arg.(value & opt (some bool) None & info ["favourited"; "f"] ~docv:"BOOL" ~doc)

     

       230
       +
       

     

       231
       +
       let tags_arg =

     

       232
       +
         let doc = "Filter by tags (comma-separated)" in

     

       233
       +
         Arg.(value & opt (list ~sep:',' string) [] & info ["tags"; "t"] ~docv:"TAGS" ~doc)

     

       234
       +
       

     

       235
       +
       let bookmark_id_arg =

     

       236
       +
         let doc = "Bookmark ID" in

     

       237
       +
         Arg.(required & pos 0 (some string) None & info [] ~docv:"ID" ~doc)

     

       238
       +
       

     

       239
       +
       let url_arg =

     

       240
       +
         let doc = "URL to bookmark" in

     

       241
       +
         Arg.(required & pos 0 (some string) None & info [] ~docv:"URL" ~doc)

     

       242
       +
       

     

       243
       +
       let title_arg =

     

       244
       +
         let doc = "Bookmark title" in

     

       245
       +
         Arg.(value & opt (some string) None & info ["title"] ~docv:"TITLE" ~doc)

     

       246
       +
       

     

       247
       +
       let note_arg =

     

       248
       +
         let doc = "Bookmark note/description" in

     

       249
       +
         Arg.(value & opt (some string) None & info ["note"; "n"] ~docv:"NOTE" ~doc)

     

       250
       +
       

     

       251
       +
       let create_tags_arg =

     

       252
       +
         let doc = "Tags to add (comma-separated)" in

     

       253
       +
         Arg.(value & opt (list ~sep:',' string) [] & info ["tags"; "t"] ~docv:"TAGS" ~doc)

     

       254
       +
       

     

       255
       +
       let create_archived_flag =

     

       256
       +
         let doc = "Mark bookmark as archived" in

     

       257
       +
         Arg.(value & flag & info ["archived"; "a"] ~doc)

     

       258
       +
       

     

       259
       +
       let create_favourited_flag =

     

       260
       +
         let doc = "Mark bookmark as favourited" in

     

       261
       +
         Arg.(value & flag & info ["favourited"; "f"] ~doc)

     

       262
       +
       

     

       263
       +
       (** Main commands *)

     

       264
       +
       

     

       265
       +
       (* Init command - doesn't use eiocmd since it's creating the profile *)

     

       266
       +
       let init_cmd =

     

       267
       +
         let doc = "Initialize karakeepe credentials" in

     

       268
       +
         let man = [

     

       269
       +
           `S Manpage.s_description;

     

       270
       +
           `P "Create a new credentials file for karakeepe in the XDG config directory.";

     

       271
       +
           `P "This will create ~/.config/karakeepe/keys/karakeepe.toml with the specified profile.";

     

       272
       +
           `S Manpage.s_examples;

     

       273
       +
           `P "Initialize with prompts:";

     

       274
       +
           `Pre "  karakeepe init";

     

       275
       +
           `P "Initialize with command-line arguments:";

     

       276
       +
           `Pre "  karakeepe init --api-key \"ak1_xxx\" --base-url \"https://hoard.example.com\"";

     

       277
       +
           `P "Initialize a production profile:";

     

       278
       +
           `Pre "  karakeepe init --profile production --api-key \"ak1_xxx\"";

     

       279
       +
         ] in

     

       280
       +
         let default_data = [

     

       281
       +
           ("api_key", None);  (* Will prompt if not provided *)

     

       282
       +
           ("base_url", Some "https://hoard.recoil.org")  (* Has default *)

     

       283
       +
         ] in

     

       284
       +
         let init_term =

     

       285
       +
           Eio_main.run @@ fun env ->

     

       286
       +
           Keyeio.Cmd.create_term

     

       287
       +
             ~app_name:"karakeepe"

     

       288
       +
             ~fs:env#fs

     

       289
       +
             ~service:"karakeepe"

     

       290
       +
             ~default_data

     

       291
       +
             ()

     

       292
       +
         in

     

       293
       +
         let info = Cmd.info "init" ~doc ~man in

     

       294
       +
         Cmd.v info init_term

     

       295
       +
       

     

       296
       +
       (* List command *)

     

       297
       +
       let list_cmd =

     

       298
       +
         let doc = "List bookmarks" in

     

       299
       +
         Eiocmd.run

     

       300
       +
           ~info:(Cmd.info "list" ~doc)

     

       301
       +
           ~app_name:"karakeepe"

     

       302
       +
           ~service:"karakeepe"

     

       303
       +
           Term.(const (fun base_url limit archived favourited tags env xdg profile ->

     

       304
       +
             list_bookmarks env xdg profile base_url limit archived favourited tags)

     

       305
       +
             $ base_url_arg $ limit_arg $ archived_arg $ favourited_arg $ tags_arg)

     

       306
       +
       

     

       307
       +
       (* Get command *)

     

       308
       +
       let get_cmd =

     

       309
       +
         let doc = "Get a single bookmark by ID" in

     

       310
       +
         Eiocmd.run

     

       311
       +
           ~info:(Cmd.info "get" ~doc)

     

       312
       +
           ~app_name:"karakeepe"

     

       313
       +
           ~service:"karakeepe"

     

       314
       +
           Term.(const (fun base_url bookmark_id env xdg profile ->

     

       315
       +
             get_bookmark env xdg profile base_url bookmark_id)

     

       316
       +
             $ base_url_arg $ bookmark_id_arg)

     

       317
       +
       

     

       318
       +
       (* Create command *)

     

       319
       +
       let create_cmd =

     

       320
       +
         let doc = "Create a new bookmark" in

     

       321
       +
         let man = [

     

       322
       +
           `S Manpage.s_description;

     

       323
       +
           `P "Create a new bookmark in Karakeep.";

     

       324
       +
           `S Manpage.s_examples;

     

       325
       +
           `P "Create a simple bookmark:";

     

       326
       +
           `Pre "  karakeepe create \"https://example.com\"";

     

       327
       +
           `P "Create with title and tags:";

     

       328
       +
           `Pre "  karakeepe create \"https://example.com\" --title \"Example Site\" --tags \"web,example\"";

     

       329
       +
           `P "Create as favourited:";

     

       330
       +
           `Pre "  karakeepe create \"https://example.com\" --favourited";

     

       331
       +
         ] in

     

       332
       +
         Eiocmd.run

     

       333
       +
           ~info:(Cmd.info "create" ~doc ~man)

     

       334
       +
           ~app_name:"karakeepe"

     

       335
       +
           ~service:"karakeepe"

     

       336
       +
           Term.(const (fun base_url url title note tags archived favourited env xdg profile ->

     

       337
       +
             create_bookmark env xdg profile base_url url title note tags archived favourited)

     

       338
       +
             $ base_url_arg $ url_arg $ title_arg $ note_arg $ create_tags_arg $ create_archived_flag $ create_favourited_flag)

     

       339
       +
       

     

       340
       +
       (* Search command *)

     

       341
       +
       let search_cmd =

     

       342
       +
         let doc = "Search bookmarks by tags" in

     

       343
       +
         let man = [

     

       344
       +
           `S Manpage.s_description;

     

       345
       +
           `P "Search for bookmarks by tags.";

     

       346
       +
           `S Manpage.s_examples;

     

       347
       +
           `P "Search for bookmarks with tag 'work':";

     

       348
       +
           `Pre "  karakeepe search --tags work";

     

       349
       +
           `P "Search for bookmarks with multiple tags:";

     

       350
       +
           `Pre "  karakeepe search --tags \"work,important\"";

     

       351
       +
         ] in

     

       352
       +
         Eiocmd.run

     

       353
       +
           ~info:(Cmd.info "search" ~doc ~man)

     

       354
       +
           ~app_name:"karakeepe"

     

       355
       +
           ~service:"karakeepe"

     

       356
       +
           Term.(const (fun base_url tags limit env xdg profile ->

     

       357
       +
             search_bookmarks env xdg profile base_url tags limit)

     

       358
       +
             $ base_url_arg $ tags_arg $ limit_arg)

     

       359
       +
       

     

       360
       +
       (* Main command *)

     

       361
       +
       let () =

     

       362
       +
         let doc = "Karakeep command-line client" in

     

       363
       +
         let man = [

     

       364
       +
           `S Manpage.s_description;

     

       365
       +
           `P "A command-line client for managing bookmarks in Karakeep (Hoarder).";

     

       366
       +
           `P "Credentials are stored securely using keyeio in XDG config directories.";

     

       367
       +
           `S Manpage.s_commands;

     

       368
       +
           `S "CONFIGURATION";

     

       369
       +
           `P "Initialize credentials using:";

     

       370
       +
           `Pre "  karakeepe init";

     

       371
       +
           `P "Or manually create ~/.config/karakeepe/keys/karakeepe.toml:";

     

       372
       +
           `Pre "[default]\napi_key = \"ak1_<key_id>_<secret>\"\nbase_url = \"https://hoard.example.com\"";

     

       373
       +
           `S Manpage.s_bugs;

     

       374
       +
           `P "Report bugs at https://github.com/avsm/knot/issues";

     

       375
       +
         ] in

     

       376
       +
         let info = Cmd.info "karakeepe" ~version:"0.1.0" ~doc ~man in

     

       377
       +
         let main_cmd = Cmd.group info [init_cmd; list_cmd; get_cmd; create_cmd; search_cmd] in

     

       378
       +
       

     

       379
       +
         exit (Cmd.eval' main_cmd)