kitchenowl-api_skill

Overview

This skill provides a reusable CLI wrapper to interact with KitchenOwl APIs for login, token handling, REST and GraphQL calls, and shopping-list read/update operations. It is designed to work with both self-hosted and cloud KitchenOwl instances. The script stores session tokens locally and supports probing endpoints to discover available APIs.

How this skill works

The script uses curl and jq to make authenticated REST and GraphQL requests, managing access and refresh tokens in a local session file (~/.config/kitchenowl-api/session.json). It supports environment variables for base URL and tokens, and includes commands to probe endpoints, login, perform generic requests, and send GraphQL queries. Shopping-list tasks are handled via the request subcommand against the instance's shopping-list endpoints.

When to use it

• You need to read or modify shopping-list items on a KitchenOwl instance.
• You want to automate API interactions without using the web UI.
• You need to probe an unfamiliar KitchenOwl instance to discover available endpoints.
• You need to script login and token refresh flows for CI or local automation.
• You want a portable CLI to run REST or GraphQL calls against KitchenOwl.

Best practices

• Run probe before other commands to discover API endpoints and GraphQL availability.
• Use environment variables (KITCHENOWL_URL, KITCHENOWL_TOKEN) to avoid embedding secrets in scripts.
• Use the login command to create locally stored session tokens rather than passing passwords to each call.
• Inspect /api root or instance docs when shopping-list endpoint paths are unknown.
• When working behind a reverse proxy, verify the base URL and correct any broken redirects.

Example use cases

• Automate weekly export of shopping-list items from a self-hosted KitchenOwl instance.
• Add or remove items programmatically from a grocery list as part of a home automation workflow.
• Run a probe to validate API endpoints and GraphQL schema on a newly deployed instance.
• Use the login command in CI to obtain a token and then run scripted REST calls against user endpoints.
• Patch or create shopping-list entries via a small script that calls request POST/PUT to the proper API path.