pp-pokeapi

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

PokéAPI — Printing Press CLI

PokéAPI — Printing Press CLI

Prerequisites: Install the CLI

前提条件:安装CLI工具

This skill drives the
pokeapi-pp-cli
binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
  1. Install via the Printing Press installer:
    bash
    npx -y @mvanhorn/printing-press install pokeapi --cli-only
  2. Verify:
    pokeapi-pp-cli --version
  3. Ensure
    $GOPATH/bin
    (or
    $HOME/go/bin
    ) is on
    $PATH
    .
If the
npx
install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.23+):
bash
go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/pokeapi/cmd/pokeapi-pp-cli@latest
If
--version
reports "command not found" after install, the install step did not put the binary on
$PATH
. Do not proceed with skill commands until verification succeeds.
本技能基于
pokeapi-pp-cli
可执行文件运行。在调用本技能的任何命令之前,你必须确认CLI工具已安装。 如果未安装,请先执行以下步骤安装:
  1. 通过Printing Press安装器安装:
    bash
    npx -y @mvanhorn/printing-press install pokeapi --cli-only
  2. 验证安装:
    pokeapi-pp-cli --version
  3. 确保
    $GOPATH/bin
    (或
    $HOME/go/bin
    )已添加到
    $PATH
    环境变量中。
如果
npx
安装失败(如无Node环境、离线等情况),可改用Go直接安装(要求Go 1.23及以上版本):
bash
go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/pokeapi/cmd/pokeapi-pp-cli@latest
如果执行
--version
时提示“command not found”,说明安装程序未将可执行文件添加到
$PATH
中。请在验证安装成功后再执行技能命令。

When to Use This CLI

何时使用本CLI工具

Reach for this CLI when you want a fully-local, fully-queryable Pokédex. It is ideal for agents answering Pokémon questions without spending live API calls, for battle-planning workflows that combine type math and learnset filtering, and for any reverse-search question (find the move, the ability, the form, the requirement) that the live REST surface doesn't natively answer. Skip it for purely image-driven workflows where another tool already handles sprite rendering.
当你需要一个完全本地化、可自由查询的宝可梦图鉴时,即可使用本CLI工具。它非常适合智能体在不调用在线API的情况下回答宝可梦相关问题,也适用于结合属性克制计算和技能学习列表筛选的对战规划工作流,以及在线REST接口无法原生支持的反向搜索问题(查找技能、特性、形态、进化条件等)。若你的工作流仅涉及图像展示,且已有其他工具处理精灵渲染,则无需使用本工具。

When Not to Use This CLI

何时不使用本CLI工具

Do not activate this CLI for requests that require creating, updating, deleting, publishing, commenting, upvoting, inviting, ordering, sending messages, booking, purchasing, or changing remote state. This printed CLI exposes read-only commands for inspection, export, sync, and analysis.
请勿在需要创建、更新、删除、发布、评论、点赞、邀请、下单、发送消息、预订、购买或修改远程状态的请求中激活本CLI工具。本CLI工具仅提供用于查看、导出、同步和分析的只读命令。

Unique Capabilities

独特功能

These capabilities aren't available in any other tool for this API.
这些功能是其他基于该API的工具所不具备的。

Local store that compounds

可累积的本地存储

  • pokemon by-ability
    — Find every Pokémon with a given ability. Live API has no reverse index — this is a single SQL query against the local store.
    Reach for this when an agent needs to enumerate Pokémon by trait without making thousands of API calls.
    bash
    pokeapi-pp-cli pokemon by-ability levitate --json --select name,types
  • move find
    — Find moves by status effect, damage class, type, or target — e.g. all moves that paralyze a Steel-type.
    Use this for battle planning questions framed by effect rather than by move name.
    bash
    pokeapi-pp-cli move find --effect paralyze --type-target steel --json
  • team suggest
    — Given an in-progress team, score every remaining Pokémon by how well it covers the team's typing gaps. Returns top candidates.
    Best for team-building agents that need objective gap-coverage scoring rather than vibes-based recommendations.
    bash
    pokeapi-pp-cli team suggest pikachu,charizard --slots 6 --json --select name,types,score
  • pokemon diff-learnset
    — Compare the move learnsets of two Pokémon (often regional forms or megas) and surface what each can learn that the other cannot.
    Useful when an agent needs to argue 'why pick form X over form Y' with concrete move evidence.
    bash
    pokeapi-pp-cli pokemon diff-learnset charizard charizard-mega-x --json
  • pokemon history
    — Show how a Pokémon has changed over generations: type changes, stat changes, ability changes, and which generation it was introduced in.
    Reach for this when answering historical Pokémon questions ('was Clefairy always a Fairy type?').
    bash
    pokeapi-pp-cli pokemon history clefairy --json
  • pokemon forms
    — List every form for a species (e.g. Vulpix vs Alolan Vulpix) with type, stat, and ability deltas inline.
    Use when an agent needs a species-wide answer rather than a single-form payload.
    bash
    pokeapi-pp-cli pokemon forms vulpix --json
  • evolve into
    — Given a target Pokémon, surface the species you would need to evolve and the conditions (item, level, friendship, time of day) to get there.
    Pick this when the user knows the Pokémon they want and needs the path to it, not the inverse.
    bash
    pokeapi-pp-cli evolve into umbreon --json
  • team gaps
    — List which of the 18 types your in-progress team has neither defensive resistance nor offensive super-effectiveness against.
    Use when answering 'what would a hostile team most likely exploit on this lineup?'
    bash
    pokeapi-pp-cli team gaps pikachu,charizard,blastoise --json
  • encounters by-region
    — Render a region-level encounter table joining locations, areas, encounters, and species — every Pokémon you can find in (e.g.) Kanto.
    When the question is regional ('what catches in Kanto?') rather than per-Pokémon.
    bash
    pokeapi-pp-cli encounters by-region kanto --version red --json
  • pokemon by-ability
    — 查找拥有指定特性的所有宝可梦。在线API没有反向索引,而本工具只需对本地存储执行一次SQL查询即可完成。
    当智能体需要枚举具有特定特性的宝可梦,且无需调用数千次API时,可使用此命令。
    bash
    pokeapi-pp-cli pokemon by-ability levitate --json --select name,types
  • move find
    — 按状态效果、伤害类型、属性或目标查找技能,例如所有能使钢属性宝可梦麻痹的技能。
    适用于以效果而非技能名称为核心的对战规划问题。
    bash
    pokeapi-pp-cli move find --effect paralyze --type-target steel --json
  • team suggest
    — 基于已有的队伍,对剩余所有宝可梦进行评分,找出最能弥补队伍属性短板的候选宝可梦,并返回排名靠前的结果。
    最适合需要客观属性短板覆盖评分而非主观推荐的队伍构建智能体。
    bash
    pokeapi-pp-cli team suggest pikachu,charizard --slots 6 --json --select name,types,score
  • pokemon diff-learnset
    — 比较两只宝可梦(通常是地区形态或超级进化形态)的技能学习列表,展示各自独有的技能。
    当智能体需要用具体的技能证据论证“为何选择形态X而非形态Y”时,可使用此命令。
    bash
    pokeapi-pp-cli pokemon diff-learnset charizard charizard-mega-x --json
  • pokemon history
    — 展示宝可梦在各世代中的变化:属性变更、种族值变更、特性变更以及它首次登场的世代。
    适用于回答宝可梦历史相关问题(如“胖丁一直是妖精属性吗?”)。
    bash
    pokeapi-pp-cli pokemon history clefairy --json
  • pokemon forms
    — 列出某一宝可梦物种的所有形态(如六尾与阿罗拉六尾),并附带属性、种族值和特性的差异信息。
    当智能体需要获取某一物种的整体信息而非单一形态数据时,可使用此命令。
    bash
    pokeapi-pp-cli pokemon forms vulpix --json
  • evolve into
    — 给定目标宝可梦,展示需要进化的初始物种以及进化所需的条件(道具、等级、亲密度、时间等)。
    当用户知道想要的宝可梦,需要获取进化路径而非反向查询时,可使用此命令。
    bash
    pokeapi-pp-cli evolve into umbreon --json
  • team gaps
    — 列出当前队伍既无防御抗性也无攻击克制的18种属性。
    适用于回答“敌方队伍最可能利用我方队伍的哪些弱点?”这类问题。
    bash
    pokeapi-pp-cli team gaps pikachu,charizard,blastoise --json
  • encounters by-region
    — 生成区域级别的遭遇表,整合地点、区域、遭遇信息和宝可梦物种,展示在指定地区(如关都)可捕获的所有宝可梦。
    适用于以地区为核心的问题(如“关都地区能捕获哪些宝可梦?”),而非针对单个宝可梦的查询。
    bash
    pokeapi-pp-cli encounters by-region kanto --version red --json

Agent-native plumbing

智能体原生支持

  • search
    — Full-text search across Pokémon, moves, abilities, items, and locations — names plus flavor text — with relevance ranking.
    Agent fallback when names are partial or fuzzy; replaces multiple list calls + grep.
    bash
    pokeapi-pp-cli search "flame" --type move --limit 10 --json
  • sql
    — Read-only SQL access to the local store. Power users and agents can compose joins the CLI doesn't expose directly.
    Reach for this when a one-off question doesn't have a dedicated subcommand.
    bash
    pokeapi-pp-cli sql "SELECT id FROM resources WHERE resource_type='pokemon' ORDER BY id LIMIT 10" --json
  • search
    — 对宝可梦、技能、特性、道具和地点进行全文搜索,涵盖名称和描述文本,并按相关性排序。
    当名称不完整或模糊时,智能体可使用此命令作为备选方案,替代多次列表调用和grep操作。
    bash
    pokeapi-pp-cli search "flame" --type move --limit 10 --json
  • sql
    — 对本地存储的只读SQL访问权限。高级用户和智能体可编写CLI未直接提供的关联查询。
    当遇到一次性问题且没有对应的专用子命令时,可使用此命令。
    bash
    pokeapi-pp-cli sql "SELECT id FROM resources WHERE resource_type='pokemon' ORDER BY id LIMIT 10" --json

Battle math

对战计算

  • damage
    — Compute expected damage range for a move from one Pokémon to another, factoring in STAB, type effectiveness, level, and base stats.
    Reach for this on every battle-planning question framed as 'will it KO?' or 'how hard does X hit Y?'
    bash
    pokeapi-pp-cli damage charizard blastoise hydro-pump --level1 50 --level2 50 --json
  • pokemon top
    — Rank Pokémon by a base stat (attack, special-attack, speed, hp, etc.), optionally filtered by type. Returns the top N.
    Use when learning the meta or filling a role on a team where the question is 'who's the best X-type at Y?'
    bash
    pokeapi-pp-cli pokemon top --by special-attack --type ghost --limit 10 --json
  • damage
    — 计算一只宝可梦使用某技能攻击另一只宝可梦的预期伤害范围,考虑本属性加成(STAB)、属性克制、等级和基础种族值。
    适用于所有以“能否一击必杀?”或“X攻击Y的伤害有多高?”为核心的对战规划问题。
    bash
    pokeapi-pp-cli damage charizard blastoise hydro-pump --level1 50 --level2 50 --json
  • pokemon top
    — 按基础种族值(攻击、特攻、速度、HP等)对宝可梦进行排名,可按属性筛选,返回排名前N的结果。
    适用于了解对战环境或为队伍填充特定角色的场景,例如“谁是最佳的幽灵属性特攻手?”
    bash
    pokeapi-pp-cli pokemon top --by special-attack --type ghost --limit 10 --json

Command Reference

命令参考

ability — Manage ability
  • pokeapi-pp-cli ability list
    — Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible...
  • pokeapi-pp-cli ability retrieve
    — Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible...
berry — Manage berry
  • pokeapi-pp-cli berry list
    — Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage...
  • pokeapi-pp-cli berry retrieve
    — Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage...
berry-firmness — Manage berry firmness
berry-flavor — Manage berry flavor
  • pokeapi-pp-cli berry-flavor list
    — Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their nature. Check out...
  • pokeapi-pp-cli berry-flavor retrieve
    — Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their nature. Check out...
characteristic — Manage characteristic
  • pokeapi-pp-cli characteristic list
    — Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by...
  • pokeapi-pp-cli characteristic retrieve
    — Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by...
contest-effect — Manage contest effect
  • pokeapi-pp-cli contest-effect list
    — Contest effects refer to the effects of moves when used in contests.
  • pokeapi-pp-cli contest-effect retrieve
    — Contest effects refer to the effects of moves when used in contests.
contest-type — Manage contest type
  • pokeapi-pp-cli contest-type list
    — Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out...
  • pokeapi-pp-cli contest-type retrieve
    — Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out...
egg-group — Manage egg group
  • pokeapi-pp-cli egg-group list
    — Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one...
  • pokeapi-pp-cli egg-group retrieve
    — Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one...
encounter-condition — Manage encounter condition
  • pokeapi-pp-cli encounter-condition list
    — Conditions which affect what pokemon might appear in the wild, e.g., day or night.
  • pokeapi-pp-cli encounter-condition retrieve
    — Conditions which affect what pokemon might appear in the wild, e.g., day or night.
encounter-condition-value — Manage encounter condition value
  • pokeapi-pp-cli encounter-condition-value list
    — Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be...
  • pokeapi-pp-cli encounter-condition-value retrieve
    — Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be...
encounter-method — Manage encounter method
  • pokeapi-pp-cli encounter-method list
    — Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out...
  • pokeapi-pp-cli encounter-method retrieve
    — Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out...
evolution-chain — Manage evolution chain
  • pokeapi-pp-cli evolution-chain list
    — Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution...
  • pokeapi-pp-cli evolution-chain retrieve
    — Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution...
evolution-trigger — Manage evolution trigger
  • pokeapi-pp-cli evolution-trigger list
    — Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out...
  • pokeapi-pp-cli evolution-trigger retrieve
    — Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out...
gender — Manage gender
  • pokeapi-pp-cli gender list
    — Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual...
  • pokeapi-pp-cli gender retrieve
    — Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual...
generation — Manage generation
  • pokeapi-pp-cli generation list
    — A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each...
  • pokeapi-pp-cli generation retrieve
    — A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each...
growth-rate — Manage growth rate
  • pokeapi-pp-cli growth-rate list
    — Growth rates are the speed with which Pokémon gain levels through experience. Check out...
  • pokeapi-pp-cli growth-rate retrieve
    — Growth rates are the speed with which Pokémon gain levels through experience. Check out...
item — An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.
  • pokeapi-pp-cli item list
    — An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have...
  • pokeapi-pp-cli item retrieve
    — An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have...
item-attribute — Manage item attribute
  • pokeapi-pp-cli item-attribute list
    — Item attributes define particular aspects of items, e.g.'usable in battle' or 'consumable'.
  • pokeapi-pp-cli item-attribute retrieve
    — Item attributes define particular aspects of items, e.g.'usable in battle' or 'consumable'.
item-category — Manage item category
  • pokeapi-pp-cli item-category list
    — Item categories determine where items will be placed in the players bag.
  • pokeapi-pp-cli item-category retrieve
    — Item categories determine where items will be placed in the players bag.
item-fling-effect — Manage item fling effect
  • pokeapi-pp-cli item-fling-effect list
    — The various effects of the move'Fling' when used with different items.
  • pokeapi-pp-cli item-fling-effect retrieve
    — The various effects of the move'Fling' when used with different items.
item-pocket — Manage item pocket
  • pokeapi-pp-cli item-pocket list
    — Pockets within the players bag used for storing items by category.
  • pokeapi-pp-cli item-pocket retrieve
    — Pockets within the players bag used for storing items by category.
language — Manage language
  • pokeapi-pp-cli language list
    — Languages for translations of API resource information.
  • pokeapi-pp-cli language retrieve
    — Languages for translations of API resource information.
location — Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
  • pokeapi-pp-cli location list
    — Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
  • pokeapi-pp-cli location retrieve
    — Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
location-area — Manage location area
  • pokeapi-pp-cli location-area list
    — Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible...
  • pokeapi-pp-cli location-area retrieve
    — Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible...
machine — Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine.
  • pokeapi-pp-cli machine list
    — Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is...
  • pokeapi-pp-cli machine retrieve
    — Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is...
meta — Manage meta
  • pokeapi-pp-cli meta
    — Returns metadata about the current deployed version of the API, including the git commit hash, deploy date, and tag...
move — Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas.
  • pokeapi-pp-cli move list
    — Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including...
  • pokeapi-pp-cli move retrieve
    — Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including...
move-ailment — Manage move ailment
  • pokeapi-pp-cli move-ailment list
    — Move Ailments are status conditions caused by moves used during battle. See...
  • pokeapi-pp-cli move-ailment retrieve
    — Move Ailments are status conditions caused by moves used during battle. See...
move-battle-style — Manage move battle style
move-category — Manage move category
  • pokeapi-pp-cli move-category list
    — Very general categories that loosely group move effects.
  • pokeapi-pp-cli move-category retrieve
    — Very general categories that loosely group move effects.
move-damage-class — Manage move damage class
  • pokeapi-pp-cli move-damage-class list
    — Damage classes moves can have, e.g. physical, special, or non-damaging.
  • pokeapi-pp-cli move-damage-class retrieve
    — Damage classes moves can have, e.g. physical, special, or non-damaging.
move-learn-method — Manage move learn method
  • pokeapi-pp-cli move-learn-method list
    — Methods by which Pokémon can learn moves.
  • pokeapi-pp-cli move-learn-method retrieve
    — Methods by which Pokémon can learn moves.
move-target — Manage move target
  • pokeapi-pp-cli move-target list
    — Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.
  • pokeapi-pp-cli move-target retrieve
    — Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.
nature — Manage nature
  • pokeapi-pp-cli nature list
    — Natures influence how a Pokémon's stats grow. See Bulbapedia for...
  • pokeapi-pp-cli nature retrieve
    — Natures influence how a Pokémon's stats grow. See Bulbapedia for...
pal-park-area — Manage pal park area
  • pokeapi-pp-cli pal-park-area list
    — Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.
  • pokeapi-pp-cli pal-park-area retrieve
    — Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.
pokeathlon-stat — Manage pokeathlon stat
  • pokeapi-pp-cli pokeathlon-stat list
    — Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions...
  • pokeapi-pp-cli pokeathlon-stat retrieve
    — Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions...
pokedex — Manage pokedex
  • pokeapi-pp-cli pokedex list
    — A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information...
  • pokeapi-pp-cli pokedex retrieve
    — A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information...
pokemon — Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See Bulbapedia for greater detail.
  • pokeapi-pp-cli pokemon list
    — Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and...
  • pokeapi-pp-cli pokemon retrieve
    — Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and...
pokemon-color — Manage pokemon color
  • pokeapi-pp-cli pokemon-color list
    — Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent...
  • pokeapi-pp-cli pokemon-color retrieve
    — Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent...
pokemon-form — Manage pokemon form
  • pokeapi-pp-cli pokemon-form list
    — Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For...
  • pokeapi-pp-cli pokemon-form retrieve
    — Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For...
pokemon-habitat — Manage pokemon habitat
  • pokeapi-pp-cli pokemon-habitat list
    — Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or...
  • pokeapi-pp-cli pokemon-habitat retrieve
    — Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or...
pokemon-shape — Manage pokemon shape
  • pokeapi-pp-cli pokemon-shape list
    — Shapes used for sorting Pokémon in a Pokédex.
  • pokeapi-pp-cli pokemon-shape retrieve
    — Shapes used for sorting Pokémon in a Pokédex.
pokemon-species — Manage pokemon species
  • pokeapi-pp-cli pokemon-species list
    — A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all...
  • pokeapi-pp-cli pokemon-species retrieve
    — A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all...
region — Manage region
  • pokeapi-pp-cli region list
    — A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species...
  • pokeapi-pp-cli region retrieve
    — A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species...
stat — Manage stat
  • pokeapi-pp-cli stat list
    — Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels...
  • pokeapi-pp-cli stat retrieve
    — Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels...
super-contest-effect — Manage super contest effect
  • pokeapi-pp-cli super-contest-effect list
    — Super contest effects refer to the effects of moves when used in super contests.
  • pokeapi-pp-cli super-contest-effect retrieve
    — Super contest effects refer to the effects of moves when used in super contests.
type — Manage type
  • pokeapi-pp-cli type list
    — Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is...
  • pokeapi-pp-cli type retrieve
    — Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is...
version — Manage version
  • pokeapi-pp-cli version game-list
    — Versions of the games, e.g., Red, Blue or Yellow.
  • pokeapi-pp-cli version game-retrieve
    — Versions of the games, e.g., Red, Blue or Yellow.
version-group — Manage version group
  • pokeapi-pp-cli version-group list
    — Version groups categorize highly similar versions of the games.
  • pokeapi-pp-cli version-group retrieve
    — Version groups categorize highly similar versions of the games.
ability — 管理特性
  • pokeapi-pp-cli ability list
    — 特性可为宝可梦在对战或野外提供被动效果。一只宝可梦可能拥有多种可选...
  • pokeapi-pp-cli ability retrieve
    — 特性可为宝可梦在对战或野外提供被动效果。一只宝可梦可能拥有多种可选...
berry — 管理树果
  • pokeapi-pp-cli berry list
    — 树果是小型果实,可用于恢复HP、解除状态、提升种族值,甚至造成伤害...
  • pokeapi-pp-cli berry retrieve
    — 树果是小型果实,可用于恢复HP、解除状态、提升种族值,甚至造成伤害...
berry-firmness — 管理树果硬度
berry-flavor — 管理树果口味
  • pokeapi-pp-cli berry-flavor list
    — 口味决定宝可梦食用树果后是受益还是受损,这取决于宝可梦的性格。详情可查看...
  • pokeapi-pp-cli berry-flavor retrieve
    — 口味决定宝可梦食用树果后是受益还是受损,这取决于宝可梦的性格。详情可查看...
characteristic — 管理个体值特征
  • pokeapi-pp-cli characteristic list
    — 个体值特征用于指示宝可梦哪项种族值拥有最高的个体值(IV)。宝可梦的个体值特征由...
  • pokeapi-pp-cli characteristic retrieve
    — 个体值特征用于指示宝可梦哪项种族值拥有最高的个体值(IV)。宝可梦的个体值特征由...
contest-effect — 管理华丽大赛效果
  • pokeapi-pp-cli contest-effect list
    — 华丽大赛效果指技能在华丽大赛中使用时产生的效果。
  • pokeapi-pp-cli contest-effect retrieve
    — 华丽大赛效果指技能在华丽大赛中使用时产生的效果。
contest-type — 管理华丽大赛类型
  • pokeapi-pp-cli contest-type list
    — 华丽大赛类型是评委在宝可梦华丽大赛中评估宝可梦状态的分类标准。详情可查看...
  • pokeapi-pp-cli contest-type retrieve
    — 华丽大赛类型是评委在宝可梦华丽大赛中评估宝可梦状态的分类标准。详情可查看...
egg-group — 管理蛋群
  • pokeapi-pp-cli egg-group list
    — 蛋群是用于确定宝可梦能否繁殖的分类。一只宝可梦可能属于一个或两个...
  • pokeapi-pp-cli egg-group retrieve
    — 蛋群是用于确定宝可梦能否繁殖的分类。一只宝可梦可能属于一个或两个...
encounter-condition — 管理遭遇条件
  • pokeapi-pp-cli encounter-condition list
    — 影响野生宝可梦出现的条件,例如白天或黑夜。
  • pokeapi-pp-cli encounter-condition retrieve
    — 影响野生宝可梦出现的条件,例如白天或黑夜。
encounter-condition-value — 管理遭遇条件值
  • pokeapi-pp-cli encounter-condition-value list
    — 遭遇条件值是遭遇条件可能存在的各种状态,例如时间可分为...
  • pokeapi-pp-cli encounter-condition-value retrieve
    — 遭遇条件值是遭遇条件可能存在的各种状态,例如时间可分为...
encounter-method — 管理遭遇方式
  • pokeapi-pp-cli encounter-method list
    — 玩家在野外遭遇宝可梦的方式,例如在草丛中行走。详情可查看...
  • pokeapi-pp-cli encounter-method retrieve
    — 玩家在野外遭遇宝可梦的方式,例如在草丛中行走。详情可查看...
evolution-chain — 管理进化链
  • pokeapi-pp-cli evolution-chain list
    — 进化链本质上是宝可梦的家族树。从家族中最低进化阶段开始,详细描述进化...
  • pokeapi-pp-cli evolution-chain retrieve
    — 进化链本质上是宝可梦的家族树。从家族中最低进化阶段开始,详细描述进化...
evolution-trigger — 管理进化触发条件
  • pokeapi-pp-cli evolution-trigger list
    — 进化触发条件是导致宝可梦进化的事件和条件。详情可查看...
  • pokeapi-pp-cli evolution-trigger retrieve
    — 进化触发条件是导致宝可梦进化的事件和条件。详情可查看...
gender — 管理性别
  • pokeapi-pp-cli gender list
    — 性别在第二世代引入,主要用于宝可梦繁殖,也可能导致外观差异...
  • pokeapi-pp-cli gender retrieve
    — 性别在第二世代引入,主要用于宝可梦繁殖,也可能导致外观差异...
generation — 管理世代
  • pokeapi-pp-cli generation list
    — 世代是宝可梦游戏的分组,根据游戏包含的宝可梦进行划分。在每个...
  • pokeapi-pp-cli generation retrieve
    — 世代是宝可梦游戏的分组,根据游戏包含的宝可梦进行划分。在每个...
growth-rate — 管理成长率
  • pokeapi-pp-cli growth-rate list
    — 成长率是宝可梦通过经验值升级的速度。详情可查看...
  • pokeapi-pp-cli growth-rate retrieve
    — 成长率是宝可梦通过经验值升级的速度。详情可查看...
item — 道具是游戏中玩家可以拾取、放入背包并使用的物品,用途多样,包括恢复HP、提升能力、帮助捕获宝可梦或解锁新区域。
  • pokeapi-pp-cli item list
    — 道具是游戏中玩家可以拾取、放入背包并使用的物品,用途多样,包括...
  • pokeapi-pp-cli item retrieve
    — 道具是游戏中玩家可以拾取、放入背包并使用的物品,用途多样,包括...
item-attribute — 管理道具属性
  • pokeapi-pp-cli item-attribute list
    — 道具属性定义了道具的特定方面,例如“可在对战中使用”或“可消耗”。
  • pokeapi-pp-cli item-attribute retrieve
    — 道具属性定义了道具的特定方面,例如“可在对战中使用”或“可消耗”。
item-category — 管理道具分类
  • pokeapi-pp-cli item-category list
    — 道具分类决定了道具在玩家背包中的存放位置。
  • pokeapi-pp-cli item-category retrieve
    — 道具分类决定了道具在玩家背包中的存放位置。
item-fling-effect — 管理投掷道具效果
  • pokeapi-pp-cli item-fling-effect list
    — 使用“投掷”技能时,不同道具产生的各种效果。
  • pokeapi-pp-cli item-fling-effect retrieve
    — 使用“投掷”技能时,不同道具产生的各种效果。
item-pocket — 管理道具背包栏
  • pokeapi-pp-cli item-pocket list
    — 玩家背包中用于按分类存放道具的栏位。
  • pokeapi-pp-cli item-pocket retrieve
    — 玩家背包中用于按分类存放道具的栏位。
language — 管理语言
  • pokeapi-pp-cli language list
    — API资源信息的翻译语言。
  • pokeapi-pp-cli language retrieve
    — API资源信息的翻译语言。
location — 游戏中可访问的地点,构成了地区的主要部分,例如城市或道路。
  • pokeapi-pp-cli location list
    — 游戏中可访问的地点,构成了地区的主要部分,例如城市或道路。
  • pokeapi-pp-cli location retrieve
    — 游戏中可访问的地点,构成了地区的主要部分,例如城市或道路。
location-area — 管理区域地点
  • pokeapi-pp-cli location-area list
    — 区域地点是大区域的子部分,例如建筑或洞穴的楼层。每个区域都有自己的可能...
  • pokeapi-pp-cli location-area retrieve
    — 区域地点是大区域的子部分,例如建筑或洞穴的楼层。每个区域都有自己的可能...
machine — 机器是代表可教授宝可梦技能的道具,不同版本的游戏中机器可能不同,因此无法确定某个特定的TM或HM对应唯一的机器。
  • pokeapi-pp-cli machine list
    — 机器是代表可教授宝可梦技能的道具,不同版本的游戏中机器可能不同,因此无法...
  • pokeapi-pp-cli machine retrieve
    — 机器是代表可教授宝可梦技能的道具,不同版本的游戏中机器可能不同,因此无法...
meta — 管理元数据
  • pokeapi-pp-cli meta
    — 返回当前部署的API版本的元数据,包括Git提交哈希、部署日期和标签...
move — 技能是宝可梦在对战中的招式。对战中,每只宝可梦每回合可使用一个技能。部分技能(包括秘传学习器技能)也可在对战外使用,通常用于清除障碍物或探索新区域。
  • pokeapi-pp-cli move list
    — 技能是宝可梦在对战中的招式。对战中,每只宝可梦每回合可使用一个技能。部分技能(包括...
  • pokeapi-pp-cli move retrieve
    — 技能是宝可梦在对战中的招式。对战中,每只宝可梦每回合可使用一个技能。部分技能(包括...
move-ailment — 管理技能异常状态
  • pokeapi-pp-cli move-ailment list
    — 技能异常状态是对战中使用技能导致的状态条件。详情可查看...
  • pokeapi-pp-cli move-ailment retrieve
    — 技能异常状态是对战中使用技能导致的状态条件。详情可查看...
move-battle-style — 管理对战宫殿技能风格
move-category — 管理技能分类
  • pokeapi-pp-cli move-category list
    — 用于大致归类技能效果的通用分类。
  • pokeapi-pp-cli move-category retrieve
    — 用于大致归类技能效果的通用分类。
move-damage-class — 管理技能伤害类型
  • pokeapi-pp-cli move-damage-class list
    — 技能可拥有的伤害类型,例如物理、特殊或无伤害。
  • pokeapi-pp-cli move-damage-class retrieve
    — 技能可拥有的伤害类型,例如物理、特殊或无伤害。
move-learn-method — 管理技能学习方式
  • pokeapi-pp-cli move-learn-method list
    — 宝可梦学习技能的方式。
  • pokeapi-pp-cli move-learn-method retrieve
    — 宝可梦学习技能的方式。
move-target — 管理技能目标
  • pokeapi-pp-cli move-target list
    — 对战中技能可指向的目标,包括宝可梦、环境甚至其他技能。
  • pokeapi-pp-cli move-target retrieve
    — 对战中技能可指向的目标,包括宝可梦、环境甚至其他技能。
nature — 管理性格
  • pokeapi-pp-cli nature list
    — 性格影响宝可梦种族值的成长。详情可查看Bulbapedia...
  • pokeapi-pp-cli nature retrieve
    — 性格影响宝可梦种族值的成长。详情可查看Bulbapedia...
pal-park-area — 管理乐园区域
  • pokeapi-pp-cli pal-park-area list
    — 用于在乐园中分组宝可梦遭遇的区域,类似于乐园专属的栖息地。
  • pokeapi-pp-cli pal-park-area retrieve
    — 用于在乐园中分组宝可梦遭遇的区域,类似于乐园专属的栖息地。
pokeathlon-stat — 管理宝可梦大赛属性
  • pokeapi-pp-cli pokeathlon-stat list
    — 宝可梦大赛属性是宝可梦在宝可梦大赛中的不同表现属性。在宝可梦大赛中,比赛...
  • pokeapi-pp-cli pokeathlon-stat retrieve
    — 宝可梦大赛属性是宝可梦在宝可梦大赛中的不同表现属性。在宝可梦大赛中,比赛...
pokedex — 管理图鉴
  • pokeapi-pp-cli pokedex list
    — 宝可梦图鉴是一种手持电子百科设备,能够记录和保存宝可梦的信息...
  • pokeapi-pp-cli pokedex retrieve
    — 宝可梦图鉴是一种手持电子百科设备,能够记录和保存宝可梦的信息...
pokemon — 宝可梦是栖息在宝可梦游戏世界中的生物,可通过精灵球捕获,并通过与其他宝可梦对战进行训练。每只宝可梦属于特定的物种,但可能存在变种,使其与同物种的其他宝可梦在基础种族值、可用特性和属性上有所不同。详情可查看Bulbapedia
  • pokeapi-pp-cli pokemon list
    — 宝可梦是栖息在宝可梦游戏世界中的生物,可通过精灵球捕获,并...
  • pokeapi-pp-cli pokemon retrieve
    — 宝可梦是栖息在宝可梦游戏世界中的生物,可通过精灵球捕获,并...
pokemon-color — 管理宝可梦颜色
  • pokeapi-pp-cli pokemon-color list
    — 用于在图鉴中对宝可梦进行分类的颜色,通常是宝可梦最明显的颜色...
  • pokeapi-pp-cli pokemon-color retrieve
    — 用于在图鉴中对宝可梦进行分类的颜色,通常是宝可梦最明显的颜色...
pokemon-form — 管理宝可梦形态
  • pokeapi-pp-cli pokemon-form list
    — 部分宝可梦可能有多种外观不同的形态,这些差异仅为 cosmetic(外观)层面。详情可查看...
  • pokeapi-pp-cli pokemon-form retrieve
    — 部分宝可梦可能有多种外观不同的形态,这些差异仅为 cosmetic(外观)层面。详情可查看...
pokemon-habitat — 管理宝可梦栖息地
  • pokeapi-pp-cli pokemon-habitat list
    — 栖息地通常是宝可梦可出现的不同地形,也可能是稀有宝可梦的专属区域...
  • pokeapi-pp-cli pokemon-habitat retrieve
    — 栖息地通常是宝可梦可出现的不同地形,也可能是稀有宝可梦的专属区域...
pokemon-shape — 管理宝可梦外形
  • pokeapi-pp-cli pokemon-shape list
    — 用于在图鉴中对宝可梦进行分类的外形。
  • pokeapi-pp-cli pokemon-shape retrieve
    — 用于在图鉴中对宝可梦进行分类的外形。
pokemon-species — 管理宝可梦物种
  • pokeapi-pp-cli pokemon-species list
    — 宝可梦物种是至少一只宝可梦的基础,同一物种的所有宝可梦共享物种属性...
  • pokeapi-pp-cli pokemon-species retrieve
    — 宝可梦物种是至少一只宝可梦的基础,同一物种的所有宝可梦共享物种属性...
region — 管理地区
  • pokeapi-pp-cli region list
    — 地区是宝可梦世界中的有组织区域,不同地区的主要区别在于包含的宝可梦物种...
  • pokeapi-pp-cli region retrieve
    — 地区是宝可梦世界中的有组织区域,不同地区的主要区别在于包含的宝可梦物种...
stat — 管理种族值
  • pokeapi-pp-cli stat list
    — 种族值决定了对战的某些方面。每只宝可梦的每项种族值都会随等级提升而增长...
  • pokeapi-pp-cli stat retrieve
    — 种族值决定了对战的某些方面。每只宝可梦的每项种族值都会随等级提升而增长...
super-contest-effect — 管理超级华丽大赛效果
  • pokeapi-pp-cli super-contest-effect list
    — 超级华丽大赛效果指技能在超级华丽大赛中使用时产生的效果。
  • pokeapi-pp-cli super-contest-effect retrieve
    — 超级华丽大赛效果指技能在超级华丽大赛中使用时产生的效果。
type — 管理属性
  • pokeapi-pp-cli type list
    — 属性是宝可梦及其技能的特性,每种属性具有三个特性:克制哪些属性的宝可梦、被哪些属性克制、对哪些属性无效...
  • pokeapi-pp-cli type retrieve
    — 属性是宝可梦及其技能的特性,每种属性具有三个特性:克制哪些属性的宝可梦、被哪些属性克制、对哪些属性无效...
version — 管理游戏版本
  • pokeapi-pp-cli version game-list
    — 游戏版本,例如红、蓝或黄。
  • pokeapi-pp-cli version game-retrieve
    — 游戏版本,例如红、蓝或黄。
version-group — 管理版本组
  • pokeapi-pp-cli version-group list
    — 版本组用于对高度相似的游戏版本进行分类。
  • pokeapi-pp-cli version-group retrieve
    — 版本组用于对高度相似的游戏版本进行分类。

Finding the right command

查找合适的命令

When you know what you want to do but not which command does it, ask the CLI directly:
bash
pokeapi-pp-cli which "<capability in your own words>"
which
resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code
0
means at least one match; exit code
2
means no confident match — fall back to
--help
or use a narrower query.
当你知道要做什么但不知道对应的命令时,可直接询问CLI:
bash
pokeapi-pp-cli which "<用你自己的语言描述功能>"
which
命令会将自然语言的功能查询解析为CLI精选功能索引中最匹配的命令。退出码
0
表示至少有一个匹配项;退出码
2
表示没有确定的匹配项,此时可改用
--help
或缩小查询范围。

Recipes

使用示例

What does my team leave exposed?

我的队伍存在哪些属性短板?

bash
pokeapi-pp-cli team gaps pikachu,charizard,blastoise --json
Returns every type your team has neither resistance nor super-effective answer for. One local join.
bash
pokeapi-pp-cli team gaps pikachu,charizard,blastoise --json
返回队伍既无抗性也无克制的所有属性,仅需一次本地关联查询。

Reverse-search by effect

按效果反向搜索技能

bash
pokeapi-pp-cli move find --effect paralyze --type-target steel --json --select name,type,power,accuracy
Find paralyzing moves that hit Steel — using --select to keep the response narrow for agent context.
bash
pokeapi-pp-cli move find --effect paralyze --type-target steel --json --select name,type,power,accuracy
查找可麻痹钢属性宝可梦的技能,使用
--select
参数缩小响应范围,便于智能体处理上下文。

Trim a profile to just what an agent needs

精简宝可梦信息至智能体所需内容

bash
pokeapi-pp-cli pokemon profile pikachu --json --select name,types,stats.hp,stats.attack,abilities
Use --select with dotted paths to pluck only high-gravity fields out of a deeply nested response — keeps the agent's context light.
bash
pokeapi-pp-cli pokemon profile pikachu --json --select name,types,stats.hp,stats.attack,abilities
使用
--select
和点路径从深层嵌套的响应中提取关键字段,减轻智能体的上下文负担。

Compare two regional forms

比较两种地区形态

bash
pokeapi-pp-cli pokemon diff-learnset vulpix vulpix-alola --json
Side-by-side learnset diff between Vulpix and Alolan Vulpix. One local query instead of two full API fetches.
bash
pokeapi-pp-cli pokemon diff-learnset vulpix vulpix-alola --json
对比六尾与阿罗拉六尾的技能学习列表差异,仅需一次本地查询,无需两次完整的API请求。

Custom join via SQL

通过SQL自定义关联查询

bash
pokeapi-pp-cli sql "SELECT id FROM resources WHERE resource_type='pokemon-species' ORDER BY id LIMIT 10" --json
Drop down to raw SQL when there's no first-class command — read-only, direct local-store access.
bash
pokeapi-pp-cli sql "SELECT id FROM resources WHERE resource_type='pokemon-species' ORDER BY id LIMIT 10" --json
当没有专用命令时,可直接使用原生SQL查询,提供对本地存储的只读直接访问权限。

Auth Setup

认证设置

No authentication required.
Run
pokeapi-pp-cli doctor
to verify setup.
无需认证。
执行
pokeapi-pp-cli doctor
验证设置是否正确。

Agent Mode

智能体模式

Add
--agent
to any command. Expands to:
--json --compact --no-input --no-color --yes
.
  • Pipeable — JSON on stdout, errors on stderr
  • Filterable
    --select
    keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
    bash
    pokeapi-pp-cli ability list --agent --select id,name,status
  • Previewable
    --dry-run
    shows the request without sending
  • Offline-friendly — sync/search commands can use the local SQLite store when available
  • Non-interactive — never prompts, every input is a flag
  • Read-only — do not use this CLI for create, update, delete, publish, comment, upvote, invite, order, send, or other mutating requests
在任何命令后添加
--agent
参数,等价于:
--json --compact --no-input --no-color --yes
  • 可管道传输 — JSON输出到标准输出,错误信息输出到标准错误
  • 可过滤
    --select
    参数保留字段子集,点路径可深入嵌套结构;数组可遍历元素。对于内容繁多的API,这是缩小上下文范围的关键:
    bash
    pokeapi-pp-cli ability list --agent --select id,name,status
  • 可预览
    --dry-run
    参数显示请求内容但不执行
  • 离线友好 — 同步/搜索命令可在本地SQLite存储可用时使用
  • 非交互式 — 从不弹出提示,所有输入均通过参数传递
  • 只读 — 请勿使用本CLI执行创建、更新、删除、发布、评论、点赞、邀请、下单、发送消息或其他修改状态的请求

Response envelope

响应包

Commands that read from the local store or the API wrap output in a provenance envelope:
json
{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}
Parse
.results
for data and
.meta.source
to know whether it's live or local. A human-readable
N results (live)
summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.
从本地存储或API读取数据的命令会将输出包装在来源信息包中:
json
{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}
解析
.results
获取数据,
.meta.source
可判断数据来自在线API还是本地存储。当标准输出为终端时,仅会在标准错误输出打印人类可读的
N results (live)
摘要;管道传输或智能体消费时,标准输出仅返回纯JSON。

Agent Feedback

智能体反馈

When you (or the agent) notice something off about this CLI, record it:
pokeapi-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
pokeapi-pp-cli feedback --stdin < notes.txt
pokeapi-pp-cli feedback list --json --limit 10
Entries are stored locally at
~/.pokeapi-pp-cli/feedback.jsonl
. They are never POSTed unless
POKEAPI_FEEDBACK_ENDPOINT
is set AND either
--send
is passed or
POKEAPI_FEEDBACK_AUTO_SEND=true
. Default behavior is local-only.
Write what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.
当你(或智能体)发现本CLI存在问题时,可记录反馈:
pokeapi-pp-cli feedback "--since参数是包含性的,但文档说是排他性的"
pokeapi-pp-cli feedback --stdin < notes.txt
pokeapi-pp-cli feedback list --json --limit 10
反馈条目存储在本地
~/.pokeapi-pp-cli/feedback.jsonl
文件中,仅当设置了
POKEAPI_FEEDBACK_ENDPOINT
且传递了
--send
参数或设置
POKEAPI_FEEDBACK_AUTO_SEND=true
时,才会发送反馈。默认仅存储在本地。
请记录让你感到意外的内容,而非正式的错误报告。简短、具体、一句话即可:这样的反馈更有价值。

Output Delivery

输出交付

Every command accepts
--deliver <sink>
. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
SinkEffect
stdout
Default; write to stdout only
file:<path>
Atomically write output to
<path>
(tmp + rename)
webhook:<url>
POST the output body to the URL (
application/json
or
application/x-ndjson
when
--compact
)
Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
所有命令均支持
--deliver <sink>
参数,输出会发送到指定的目标,除了(或代替)标准输出,智能体无需手动管道即可路由命令结果。支持三种目标:
目标效果
stdout
默认值;仅输出到标准输出
file:<path>
原子性地将输出写入
<path>
(先写入临时文件再重命名)
webhook:<url>
将输出体POST到指定URL(格式为
application/json
,使用
--compact
时为
application/x-ndjson
不支持的协议会返回结构化错误,并列出支持的协议。Webhook请求失败时返回非零退出码,并在标准错误输出记录URL和HTTP状态码。

Named Profiles

命名配置文件

A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
pokeapi-pp-cli profile save briefing --json
pokeapi-pp-cli --profile briefing ability list
pokeapi-pp-cli profile list --json
pokeapi-pp-cli profile show briefing
pokeapi-pp-cli profile delete briefing --yes
Explicit flags always win over profile values; profile values win over defaults.
agent-context
lists all available profiles under
available_profiles
so introspecting agents discover them at runtime.
配置文件是一组保存的参数值,可在多次调用中复用。适用于定时智能体每次运行时使用相同配置调用同一命令的场景(即HeyGen的“Beacon”模式)。
pokeapi-pp-cli profile save briefing --json
pokeapi-pp-cli --profile briefing ability list
pokeapi-pp-cli profile list --json
pokeapi-pp-cli profile show briefing
pokeapi-pp-cli profile delete briefing --yes
显式参数始终优先于配置文件中的值;配置文件中的值优先于默认值。
agent-context
命令会在
available_profiles
下列出所有可用配置文件,便于智能体在运行时发现。

Exit Codes

退出码

CodeMeaning
0Success
2Usage error (wrong arguments)
3Resource not found
5API error (upstream issue)
7Rate limited (wait and retry)
10Config error
代码含义
0成功
2使用错误(参数错误)
3资源未找到
5API错误(上游问题)
7速率限制(等待后重试)
10配置错误

Argument Parsing

参数解析

Parse
$ARGUMENTS
:
  1. Empty,
    help
    , or
    --help
    → show
    pokeapi-pp-cli --help
    output
  2. Starts with
    install
    → ends with
    mcp
    → MCP installation; otherwise → see Prerequisites above
  3. Anything else → Direct Use (execute as CLI command with
    --agent
    )
解析
$ARGUMENTS
的规则:
  1. 为空、
    help
    --help
    → 显示
    pokeapi-pp-cli --help
    的输出
  2. install
    开头
    → 若以
    mcp
    结尾 → 安装MCP服务器;否则 → 参考顶部的前提条件部分
  3. 其他情况 → 直接使用(添加
    --agent
    参数执行CLI命令)

MCP Server Installation

MCP服务器安装

  1. Install the MCP server:
    bash
    go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/pokeapi/cmd/pokeapi-pp-mcp@latest
  2. Register with Claude Code:
    bash
    claude mcp add pokeapi-pp-mcp -- pokeapi-pp-mcp
  3. Verify:
    claude mcp list
  1. 安装MCP服务器:
    bash
    go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/pokeapi/cmd/pokeapi-pp-mcp@latest
  2. 在Claude Code中注册:
    bash
    claude mcp add pokeapi-pp-mcp -- pokeapi-pp-mcp
  3. 验证:
    claude mcp list

Direct Use

直接使用

  1. Check if installed:
    which pokeapi-pp-cli
    If not found, offer to install (see Prerequisites at the top of this skill).
  2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
  3. Execute with the
    --agent
    flag:
    bash
    pokeapi-pp-cli <command> [subcommand] [args] --agent
  4. If ambiguous, drill into subcommand help:
    pokeapi-pp-cli <command> --help
    .
  1. 检查是否安装:
    which pokeapi-pp-cli
    若未找到,提供安装选项(参考顶部的前提条件部分)。
  2. 将用户查询与上述独特功能和命令参考中最匹配的命令对应。
  3. 添加
    --agent
    参数执行命令:
    bash
    pokeapi-pp-cli <command> [subcommand] [args] --agent
  4. 若存在歧义,查看子命令帮助:
    pokeapi-pp-cli <command> --help