今天很高兴为 Quail 用户推出 Quail 的命令行工具:Quail CLI。
这个命令行界面旨在简化和自动化 Quail 账户的管理,允许直接从终端进行身份验证、创建和管理文章。不管是喜欢从命令行工作的开发者,还是仅仅想更快地与 Quail 账户交互的人,Quail CLI 都能帮助提升效率。
什么是 Quail CLI?
Quail CLI 是一款能轻松执行 Quail 关键操作的命令行工具。通过直接与 Quail API 交互,它可以进行用户身份验证、管理文章和获取用户详细信息——而这一切都通过简单的命令实现。
不需要再通过 Quail 的网页界面来执行常规任务,借助命令行的速度和便利,只需几个按键就能完成操作。
主要功能
以下是 Quail CLI 能执行的主要功能:
- 使用 OAuth 进行身份验证:可以通过终端安全登录 Quail 账户。
- 管理文章:使用 markdown 文件轻松创建、更新、发布、取消发布或删除文章。
- 获取用户信息:检索当前已认证用户的详细信息。
- 自动化工作流程:可以在脚本或批处理过程中使用 Quail CLI,以进行批量操作和简化的发布流程。
入门指南
使用 Quail CLI 入门非常简单,只需安装工具并运行几个简单的命令。如果熟悉 Go,可以直接使用以下命令安装:
$ go install github.com/quail-ink/quail-cli@latest
安装完成后,运行以下命令即可开始与 Quail 账户交互:
$ quail-cli login
此命令将提示通过 OAuth 验证 Quail。按照指示操作,登录后就可以开始管理文章并检索用户信息了。
使用 Quail CLI 管理文章
Quail CLI 的亮点之一是其通过 markdown 文件管理文章的功能。对于已经在 markdown 中编写内容的用户来说,这非常适合。CLI 能够通过读取 markdown 文件中的 frontmatter 自动处理文章的创建、更新和发布。
Markdown 文章示例:
---
title: "欢迎来到未来"
slug: future-tech
datetime: 2024-10-01 10:00
summary: "介绍未来科技趋势。"
tags: tech, future, innovation
cover_image_url: "https://example.com/cover.jpg"
---
在这篇文章中,将探讨未来科技及其如何塑造世界...
> "任何足够先进的技术都与魔法无异。"
> —— 阿瑟·C·克拉克
# 未来已至
让我们深入探讨这些创新...
可以使用以下命令,通过这个 markdown 文件创建或更新文章:
$ quail-cli post upsert your_post.md -l your_list_slug
如果文章已存在,Quail CLI 将更新文章。如果不存在,它将为创建一篇新文章!
文章发布及其他操作
发布文章同样简单:
$ quail-cli post publish -l your_list_slug -p your_post_slug
类似的命令可以用来取消发布、递送以及删除文章,完全可以在终端中处理所有内容管理需求。
配置选项
Quail CLI 提供了灵活的配置系统,允许自定义与 Quail 的交互方式。配置存储在 YAML 文件中,CLI 默认在 $HOME/.config/quail-cli/config.yaml
路径下查找配置文件。
以下是一个配置文件示例:
app:
access_token: ""
expiry: ""
refresh_token: ""
token_type: ""
post:
frontmatter_mapping:
cover_image_url: featureImage
可以将不同的 frontmatter 键映射到 Quail 的文章属性,从而完全控制文章的结构和提交方式。
谁应该使用 Quail CLI?
不论是作家、开发者,还是管理多个新闻通讯的人,Quail CLI 都能简化工作流程。如果更喜欢在终端中工作,或者需要一种方法来自动执行发布文章、检索用户数据或批量管理内容的任务,那么这个工具非常适合。
开发者会喜欢它通过 Go 进行的简易安装过程,而作家则会喜欢通过 markdown 文件和终端管理文章的简便性。
写在最后
Quail CLI 是开源的,欢迎社区贡献。如果遇到任何问题或有新的功能建议,可以随时在 GitHub 或者 文档 查阅使用方法、提交问题或提出拉取请求。