@spectratools/defillama-cli 0.4.0 → 0.4.3

package/README.md

@@ -0,0 +1,101 @@
+# @spectratools/defillama-cli
+
+Query DefiLlama API data from the command line — TVL, volume, fees, and token prices.
+
+## Install
+
+```bash
+pnpm add -g @spectratools/defillama-cli
+```
+
+## LLM / Agent Discovery
+
+```bash
+# Emit machine-readable command metadata
+defillama-cli --llms
+
+# Register as a reusable local skill for agent runtimes
+defillama-cli skills add
+
+# Register as an MCP server entry
+defillama-cli mcp add
+```
+
+## Quick Start
+
+No API key required — DefiLlama is a free, public API.
+
+```bash
+# Top 10 protocols by TVL
+defillama-cli tvl protocols --limit 10
+
+# Top chains by TVL
+defillama-cli tvl chains --limit 10
+
+# Protocol detail with chain breakdown
+defillama-cli tvl protocol aave
+
+# TVL history for a protocol
+defillama-cli tvl history aave --days 7
+
+# Top DEXes by 24h volume
+defillama-cli volume dexs --limit 10
+
+# Volume for a specific DEX
+defillama-cli volume protocol uniswap
+
+# DEX aggregators ranked by volume
+defillama-cli volume aggregators --limit 10
+
+# Top protocols by fees
+defillama-cli fees overview --limit 10
+
+# Fee detail for a protocol
+defillama-cli fees protocol aave
+
+# Current token price
+defillama-cli prices current ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7
+
+# Historical token price
+defillama-cli prices historical ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7 --date 2025-01-01
+
+# Price chart
+defillama-cli prices chart ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7 --start 2025-01-01 --period 1d
+```
+
+## Command Groups
+
+| Group | Description |
+|-------|-------------|
+| `tvl` | Total value locked — protocols, chains, protocol detail, history |
+| `volume` | DEX trading volume — dexs, protocol detail, aggregators |
+| `fees` | Protocol fees and revenue — overview, protocol detail |
+| `prices` | Token prices — current, historical, chart |
+
+## Chain Filtering
+
+Several commands support `--chain` to filter by blockchain:
+
+```bash
+defillama-cli tvl protocols --chain ethereum --limit 10
+defillama-cli volume dexs --chain abstract --limit 10
+defillama-cli fees overview --chain base --limit 10
+```
+
+## Output Modes
+
+```bash
+# Human-readable table output (default)
+defillama-cli tvl protocols --limit 5
+
+# JSON output for pipelines
+defillama-cli tvl protocols --limit 5 --json
+```
+
+## Documentation
+
+Full documentation: [spectratools.dev/defillama](https://spectratools.dev/defillama/)
+
+## License
+
+MIT

package/dist/cli.js

@@ -306,9 +306,12 @@ var pricesCli = Cli2.create("prices", {
   description: "Token price queries via coins.llama.fi."
 });
 var COIN_ID_RE = /^[a-zA-Z0-9_-]+:0x[a-fA-F0-9]{1,}$/;
+function normalizeCoinArgs(raw) {
+  return Array.isArray(raw) ? raw : [raw];
+}
 function parseCoins(raw) {
   const coins = [];
-  for (const arg of raw) {
+  for (const arg of normalizeCoinArgs(raw)) {
     for (const part of arg.split(",")) {
       const trimmed = part.trim();
       if (trimmed.length === 0) continue;
@@ -337,10 +340,11 @@ function parseTimestamp(value) {
   }
   return Math.floor(ms / 1e3);
 }
+var coinsArgsSchema = z3.string().describe("Coin identifiers (chainName:0xAddress)");
 pricesCli.command("current", {
   description: "Get current prices for one or more tokens.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     "search-width": z3.string().default("4h").describe("Timestamp search width (e.g. 4h, 6h)")
@@ -358,7 +362,7 @@ pricesCli.command("current", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       description: "Current price of USDT on Ethereum"
     }
   ],
@@ -382,7 +386,7 @@ pricesCli.command("current", {
 pricesCli.command("historical", {
   description: "Get token prices at a specific point in time.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     timestamp: z3.string().optional().describe("Unix timestamp in seconds"),
@@ -401,7 +405,7 @@ pricesCli.command("historical", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       options: { date: "2025-01-01" },
       description: "USDT price on 2025-01-01"
     }
@@ -430,7 +434,7 @@ pricesCli.command("historical", {
 pricesCli.command("chart", {
   description: "Get a price chart over a time range.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     start: z3.string().optional().describe("Start timestamp or ISO date"),
@@ -455,7 +459,7 @@ pricesCli.command("chart", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       options: { start: "2025-01-01", period: "1d" },
       description: "USDT daily price chart since 2025-01-01"
     }
@@ -861,6 +865,22 @@ cli.command(tvlCli);
 cli.command(volumeCli);
 cli.command(feesCli);
 cli.command(pricesCli);
+var PRICE_SUBCOMMANDS = /* @__PURE__ */ new Set(["current", "historical", "chart"]);
+function normalizePricesArgv(argv) {
+  if (argv[0] !== "prices") return argv;
+  const subcommand = argv[1];
+  if (!subcommand || !PRICE_SUBCOMMANDS.has(subcommand)) return argv;
+  let i = 2;
+  const coins = [];
+  while (i < argv.length) {
+    const token = argv[i];
+    if (!token || token.startsWith("-")) break;
+    coins.push(token);
+    i += 1;
+  }
+  if (coins.length <= 1) return argv;
+  return [...argv.slice(0, 2), coins.join(","), ...argv.slice(i)];
+}
 var isMain = (() => {
   const entrypoint = process.argv[1];
   if (!entrypoint) {
@@ -873,8 +893,9 @@ var isMain = (() => {
   }
 })();
 if (isMain) {
-  cli.serve();
+  cli.serve(normalizePricesArgv(process.argv.slice(2)));
 }
 export {
-  cli
+  cli,
+  normalizePricesArgv
 };

package/dist/index.js

@@ -317,9 +317,12 @@ var pricesCli = Cli2.create("prices", {
   description: "Token price queries via coins.llama.fi."
 });
 var COIN_ID_RE = /^[a-zA-Z0-9_-]+:0x[a-fA-F0-9]{1,}$/;
+function normalizeCoinArgs(raw) {
+  return Array.isArray(raw) ? raw : [raw];
+}
 function parseCoins(raw) {
   const coins = [];
-  for (const arg of raw) {
+  for (const arg of normalizeCoinArgs(raw)) {
     for (const part of arg.split(",")) {
       const trimmed = part.trim();
       if (trimmed.length === 0) continue;
@@ -348,10 +351,11 @@ function parseTimestamp(value) {
   }
   return Math.floor(ms / 1e3);
 }
+var coinsArgsSchema = z3.string().describe("Coin identifiers (chainName:0xAddress)");
 pricesCli.command("current", {
   description: "Get current prices for one or more tokens.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     "search-width": z3.string().default("4h").describe("Timestamp search width (e.g. 4h, 6h)")
@@ -369,7 +373,7 @@ pricesCli.command("current", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       description: "Current price of USDT on Ethereum"
     }
   ],
@@ -393,7 +397,7 @@ pricesCli.command("current", {
 pricesCli.command("historical", {
   description: "Get token prices at a specific point in time.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     timestamp: z3.string().optional().describe("Unix timestamp in seconds"),
@@ -412,7 +416,7 @@ pricesCli.command("historical", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       options: { date: "2025-01-01" },
       description: "USDT price on 2025-01-01"
     }
@@ -441,7 +445,7 @@ pricesCli.command("historical", {
 pricesCli.command("chart", {
   description: "Get a price chart over a time range.",
   args: z3.object({
-    coins: z3.array(z3.string()).describe("Coin identifiers (chainName:0xAddress)")
+    coins: coinsArgsSchema
   }),
   options: z3.object({
     start: z3.string().optional().describe("Start timestamp or ISO date"),
@@ -466,7 +470,7 @@ pricesCli.command("chart", {
   }),
   examples: [
     {
-      args: { coins: ["ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7"] },
+      args: { coins: "ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7" },
       options: { start: "2025-01-01", period: "1d" },
       description: "USDT daily price chart since 2025-01-01"
     }
@@ -872,6 +876,22 @@ cli.command(tvlCli);
 cli.command(volumeCli);
 cli.command(feesCli);
 cli.command(pricesCli);
+var PRICE_SUBCOMMANDS = /* @__PURE__ */ new Set(["current", "historical", "chart"]);
+function normalizePricesArgv(argv) {
+  if (argv[0] !== "prices") return argv;
+  const subcommand = argv[1];
+  if (!subcommand || !PRICE_SUBCOMMANDS.has(subcommand)) return argv;
+  let i = 2;
+  const coins = [];
+  while (i < argv.length) {
+    const token = argv[i];
+    if (!token || token.startsWith("-")) break;
+    coins.push(token);
+    i += 1;
+  }
+  if (coins.length <= 1) return argv;
+  return [...argv.slice(0, 2), coins.join(","), ...argv.slice(i)];
+}
 var isMain = (() => {
   const entrypoint = process.argv[1];
   if (!entrypoint) {
@@ -884,7 +904,7 @@ var isMain = (() => {
   }
 })();
 if (isMain) {
-  cli.serve();
+  cli.serve(normalizePricesArgv(process.argv.slice(2)));
 }
 export {
   DEFILLAMA_HOSTS,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spectratools/defillama-cli",
-  "version": "0.4.0",
+  "version": "0.4.3",
   "description": "DefiLlama API CLI for spectra-the-bot",
   "type": "module",
   "license": "MIT",
@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "incur": "^0.3.0",
-    "@spectratools/cli-shared": "0.2.1"
+    "@spectratools/cli-shared": "0.4.1"
   },
   "devDependencies": {
     "typescript": "5.7.3",