Quail CLI logo

Quail CLI

by quailyquaily

Quail CLI is a command-line interface for interacting with Quail, designed to simplify and automate operations such as user authentication, managing posts, and fetching user details. It interacts with the Quail API to provide these functionalities.

View on GitHub

Last updated: N/A

What is Quail CLI?

Quail CLI is a tool that allows users to interact with the Quail platform from the command line. It provides commands for authentication, managing posts (create, update, delete, retrieve), and fetching user information.

How to use Quail CLI?

After installing the CLI, you can use it by running quail-cli [command]. Available commands include login, me, and post. Global flags allow you to specify the API base URL, authentication base URL, configuration file path, and output format. The login command authenticates with Quail using OAuth. The me command retrieves current user information. The post command allows you to create, update, delete, or retrieve posts.

Key features of Quail CLI

  • User authentication via OAuth

  • Post management (create, update, delete, retrieve)

  • Retrieval of user information

  • Support for human-readable and JSON output formats

  • MCP server functionality for interacting with AI models

  • Configuration file support for customization

Use cases of Quail CLI

  • Automating post creation and management workflows

  • Integrating Quail with other command-line tools

  • Fetching user details for scripting purposes

  • Using Quail as a backend for AI model interactions via MCP

  • Batch processing of post operations

FAQ from Quail CLI

How do I install Quail CLI?

You can install the latest release by downloading the binary for your platform from the releases page or manually using go install github.com/quailyquaily/quail-cli@latest.

How do I authenticate with Quail?

Use the quail-cli login command to initiate the OAuth login process.

How do I create a new post?

Use the quail-cli post upsert your_markdown_file.md -l your_list_slug command, providing the path to your markdown file and the list slug.

Where is the configuration file located?

By default, the configuration file is located at $HOME/.config/quail-cli/config.yaml. You can specify a different path using the --config flag.

What is MCP server mode?

MCP (Model Context Protocol) server mode allows you to use Quail CLI as a server for interacting with AI models. It supports SSE and stdio modes.