{
  "description": "Add, list and search bookmarks. The server address and API key come from the config file or environment (KARAKEEP_SERVER_ADDR, KARAKEEP_API_KEY), not from this form; update, delete, lists and tags are left out.",
  "name": "karakeep",
  "subcommands": [
    {
      "name": "bookmarks",
      "subcommands": [
        {
          "name": "add",
          "description": "Create bookmarks from links, notes or files.",
          "options": [
            {
              "names": [
                "--link"
              ],
              "description": "Link",
              "args": {
                "name": "link",
                "isOptional": false,
                "isVariadic": true
              },
              "isRepeatable": true
            },
            {
              "names": [
                "--note"
              ],
              "description": "Note text",
              "args": {
                "name": "note",
                "isOptional": false,
                "isVariadic": true
              },
              "isRepeatable": true
            },
            {
              "names": [
                "--asset"
              ],
              "description": "Asset file (image or PDF)",
              "args": {
                "name": "asset",
                "isOptional": false,
                "isVariadic": true,
                "template": "filepaths"
              },
              "isRepeatable": true
            },
            {
              "names": [
                "--list-id"
              ],
              "description": "List ID",
              "args": {
                "name": "list_id",
                "isOptional": false
              }
            },
            {
              "names": [
                "--tag-name"
              ],
              "description": "Tag",
              "args": {
                "name": "tag_name",
                "isOptional": false,
                "isVariadic": true
              },
              "isRepeatable": true
            },
            {
              "names": [
                "--title"
              ],
              "description": "Title",
              "args": {
                "name": "title",
                "isOptional": false
              }
            }
          ]
        },
        {
          "name": "search",
          "description": "Search with matchers such as tag:name or is:fav.",
          "options": [
            {
              "names": [
                "--limit"
              ],
              "description": "Results per page",
              "args": {
                "name": "limit",
                "isOptional": false
              }
            },
            {
              "names": [
                "--sort-order"
              ],
              "description": "Sort order",
              "args": {
                "name": "sort_order",
                "isOptional": false,
                "suggestions": [
                  {
                    "name": "relevance",
                    "description": "Relevance"
                  },
                  {
                    "name": "asc",
                    "description": "Oldest first"
                  },
                  {
                    "name": "desc",
                    "description": "Newest first"
                  }
                ]
              }
            },
            {
              "names": [
                "--search-mode"
              ],
              "description": "Search mode",
              "args": {
                "name": "search_mode",
                "isOptional": false,
                "suggestions": [
                  {
                    "name": "fts",
                    "description": "Full text"
                  },
                  {
                    "name": "semantic",
                    "description": "Semantic"
                  },
                  {
                    "name": "hybrid",
                    "description": "Hybrid"
                  }
                ]
              }
            },
            {
              "names": [
                "--include-content"
              ],
              "description": "Include full content"
            },
            {
              "names": [
                "--all"
              ],
              "description": "Fetch all pages"
            }
          ],
          "args": [
            {
              "name": "query",
              "isOptional": true
            }
          ]
        },
        {
          "name": "list",
          "description": "List bookmarks, optionally for one list or tag.",
          "options": [
            {
              "names": [
                "--include-archived"
              ],
              "description": "Include archived"
            },
            {
              "names": [
                "--list-id"
              ],
              "description": "Only this list ID",
              "args": {
                "name": "list_id",
                "isOptional": false
              }
            },
            {
              "names": [
                "--tag-id"
              ],
              "description": "Only this tag ID",
              "args": {
                "name": "tag_id",
                "isOptional": false
              }
            },
            {
              "names": [
                "--limit"
              ],
              "description": "Bookmarks per page",
              "args": {
                "name": "limit",
                "isOptional": false
              }
            },
            {
              "names": [
                "--all"
              ],
              "description": "Fetch all pages"
            }
          ]
        }
      ]
    }
  ]
}
