@quantbrasil/cli 0.1.0-beta.13 → 0.1.0-beta.15

package/dist/index.js

@@ -4,9 +4,11 @@ export * from "./cli/errors.js";
 export * from "./cli/index.js";
 export * from "./commands/assets.js";
 export * from "./commands/auth.js";
+export * from "./commands/backtests.js";
 export * from "./commands/capabilities.js";
 export * from "./commands/init.js";
 export * from "./commands/market.js";
+export * from "./commands/news.js";
 export * from "./commands/portfolios.js";
 export * from "./commands/rankings.js";
 export * from "./commands/screening.js";

package/dist/vendor/core/capabilities/backtests.d.ts

@@ -0,0 +1,207 @@
+export declare const backtestTimeframeValues: readonly ["M5", "M15", "M30", "H1", "H2", "H4", "D1", "W1"];
+export declare const backtestCapabilities: readonly [{
+    readonly id: "backtests.strategies";
+    readonly kind: "read";
+    readonly visibility: readonly ["cli", "opencode"];
+    readonly description: "Lista estratégias de backtest disponíveis, com orientação de seleção, parâmetros e defaults.";
+    readonly http: {
+        readonly method: "GET";
+        readonly path: "/api/desk/tools/backtests/strategies";
+        readonly inputMode: "none";
+        readonly schemas: {
+            readonly request: null;
+            readonly response: "BacktestStrategiesResponse";
+        };
+    };
+    readonly cli: {
+        readonly group: "backtests";
+        readonly command: "strategies";
+        readonly summary: "Lista estratégias de backtest disponíveis.";
+        readonly positional: readonly [];
+        readonly options: readonly [];
+        readonly examples: readonly ["quantbrasil backtests strategies"];
+    };
+    readonly tool: {
+        readonly name: "qb_backtests_strategies";
+        readonly title: "List backtest strategies";
+    };
+    readonly outputModes: readonly ["json", "human"];
+}, {
+    readonly id: "backtests.info";
+    readonly kind: "read";
+    readonly visibility: readonly ["cli", "opencode"];
+    readonly description: "Mostra ajuda, orientação de seleção, parâmetros aceitos, defaults e dicas de uma estratégia de backtest.";
+    readonly http: {
+        readonly method: "POST";
+        readonly path: "/api/desk/tools/backtests/strategy";
+        readonly inputMode: "json_body";
+        readonly schemas: {
+            readonly request: "BacktestStrategyRequest";
+            readonly response: "BacktestStrategyResponse";
+        };
+    };
+    readonly cli: {
+        readonly group: "backtests";
+        readonly command: "info";
+        readonly summary: "Mostra detalhes de uma estratégia de backtest.";
+        readonly positional: readonly [{
+            readonly kind: "positional";
+            readonly name: "strategy_id";
+            readonly type: "string";
+            readonly required: true;
+            readonly placeholder: "ESTRATEGIA";
+            readonly description: "ID da estratégia retornado por `backtests strategies`.";
+        }];
+        readonly options: readonly [];
+        readonly examples: readonly ["quantbrasil backtests info ifr2"];
+    };
+    readonly tool: {
+        readonly name: "qb_backtests_info";
+        readonly title: "Get backtest strategy info";
+    };
+    readonly outputModes: readonly ["json", "human"];
+}, {
+    readonly id: "backtests.get";
+    readonly kind: "read";
+    readonly visibility: readonly ["cli", "opencode"];
+    readonly description: "Retorna um backtest salvo por ID, respeitando o usuário autenticado.";
+    readonly http: {
+        readonly method: "POST";
+        readonly path: "/api/desk/tools/backtests/get";
+        readonly inputMode: "json_body";
+        readonly schemas: {
+            readonly request: "BacktestGetRequest";
+            readonly response: "BacktestGetResponse";
+        };
+    };
+    readonly cli: {
+        readonly group: "backtests";
+        readonly command: "get";
+        readonly summary: "Mostra um backtest salvo por ID.";
+        readonly positional: readonly [{
+            readonly kind: "positional";
+            readonly name: "backtest_id";
+            readonly type: "integer";
+            readonly required: true;
+            readonly placeholder: "ID";
+            readonly description: "ID do backtest salvo.";
+        }];
+        readonly options: readonly [];
+        readonly examples: readonly ["quantbrasil backtests get 123"];
+    };
+    readonly tool: {
+        readonly name: "qb_backtests_get";
+        readonly title: "Get backtest";
+    };
+    readonly outputModes: readonly ["json", "human"];
+}, {
+    readonly id: "backtests.run";
+    readonly kind: "mutation";
+    readonly visibility: readonly ["cli", "opencode"];
+    readonly description: "Executa um backtest para uma estratégia e ativo.";
+    readonly http: {
+        readonly method: "POST";
+        readonly path: "/api/desk/tools/backtests/run";
+        readonly inputMode: "json_body";
+        readonly schemas: {
+            readonly request: "BacktestRunRequest";
+            readonly response: "BacktestRunResponse";
+        };
+    };
+    readonly cli: {
+        readonly group: "backtests";
+        readonly command: "run";
+        readonly summary: "Executa um backtest individual.";
+        readonly positional: readonly [{
+            readonly kind: "positional";
+            readonly name: "strategy_id";
+            readonly type: "string";
+            readonly required: true;
+            readonly placeholder: "ESTRATEGIA";
+            readonly description: "ID da estratégia, por exemplo ifr2.";
+        }, {
+            readonly kind: "positional";
+            readonly name: "ticker";
+            readonly type: "string";
+            readonly required: true;
+            readonly placeholder: "TICKER";
+            readonly description: "Ticker do ativo, por exemplo PETR4.";
+        }];
+        readonly options: readonly [{
+            readonly kind: "option";
+            readonly flag: "--timeframe";
+            readonly name: "timeframe_id";
+            readonly type: "enum";
+            readonly required: false;
+            readonly placeholder: "TIMEFRAME";
+            readonly enumValues: readonly ["M5", "M15", "M30", "H1", "H2", "H4", "D1", "W1"];
+            readonly description: "Timeframe do backtest.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--from";
+            readonly name: "start_date";
+            readonly type: "string";
+            readonly required: false;
+            readonly placeholder: "AAAA-MM-DD";
+            readonly description: "Data inicial em ISO.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--to";
+            readonly name: "end_date";
+            readonly type: "string";
+            readonly required: false;
+            readonly placeholder: "AAAA-MM-DD";
+            readonly description: "Data final em ISO.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--capital";
+            readonly name: "capital";
+            readonly type: "number";
+            readonly required: false;
+            readonly placeholder: "VALOR";
+            readonly description: "Capital inicial do backtest.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--max-risk";
+            readonly name: "max_risk";
+            readonly type: "number";
+            readonly required: false;
+            readonly placeholder: "VALOR";
+            readonly description: "Risco máximo do backtest.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--contracts";
+            readonly name: "num_contracts";
+            readonly type: "integer";
+            readonly required: false;
+            readonly placeholder: "N";
+            readonly defaultValue: 5;
+            readonly description: "Número de contratos para ativos que usam contratos.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--param";
+            readonly name: "parameters";
+            readonly type: "string_array";
+            readonly required: false;
+            readonly placeholder: "CHAVE=VALOR";
+            readonly multiple: true;
+            readonly collectionFormat: "repeatable";
+            readonly description: "Parâmetro da estratégia. Pode ser repetido, por exemplo --param rsi=30.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--params-json";
+            readonly name: "parameters_json";
+            readonly type: "string";
+            readonly required: false;
+            readonly placeholder: "JSON";
+            readonly description: "Objeto JSON com parâmetros da estratégia.";
+        }];
+        readonly examples: readonly ["quantbrasil backtests run ifr2 PETR4 --timeframe D1 --from 2025-01-01 --to 2026-01-01", "quantbrasil backtests run ifr2 PETR4 --timeframe D1 --param rsi=30 --param window=2 --json"];
+    };
+    readonly tool: {
+        readonly name: "qb_backtests_run";
+        readonly title: "Run backtest";
+    };
+    readonly outputModes: readonly ["json", "human"];
+}];
+//# sourceMappingURL=backtests.d.ts.map

package/dist/vendor/core/capabilities/backtests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backtests.d.ts","sourceRoot":"","sources":["../../src/capabilities/backtests.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,6DAS1B,CAAC;AAWX,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+NmB,CAAC"}

package/dist/vendor/core/capabilities/backtests.js

@@ -0,0 +1,239 @@
+import { publicRuntimeVisibility, standardOutputModes } from "./shared.js";
+export const backtestTimeframeValues = [
+    "M5",
+    "M15",
+    "M30",
+    "H1",
+    "H2",
+    "H4",
+    "D1",
+    "W1",
+];
+const backtestIdPositional = {
+    kind: "positional",
+    name: "backtest_id",
+    type: "integer",
+    required: true,
+    placeholder: "ID",
+    description: "ID do backtest salvo.",
+};
+export const backtestCapabilities = [
+    {
+        id: "backtests.strategies",
+        kind: "read",
+        visibility: publicRuntimeVisibility,
+        description: "Lista estratégias de backtest disponíveis, com orientação de seleção, parâmetros e defaults.",
+        http: {
+            method: "GET",
+            path: "/api/desk/tools/backtests/strategies",
+            inputMode: "none",
+            schemas: {
+                request: null,
+                response: "BacktestStrategiesResponse",
+            },
+        },
+        cli: {
+            group: "backtests",
+            command: "strategies",
+            summary: "Lista estratégias de backtest disponíveis.",
+            positional: [],
+            options: [],
+            examples: ["quantbrasil backtests strategies"],
+        },
+        tool: {
+            name: "qb_backtests_strategies",
+            title: "List backtest strategies",
+        },
+        outputModes: standardOutputModes,
+    },
+    {
+        id: "backtests.info",
+        kind: "read",
+        visibility: publicRuntimeVisibility,
+        description: "Mostra ajuda, orientação de seleção, parâmetros aceitos, defaults e dicas de uma estratégia de backtest.",
+        http: {
+            method: "POST",
+            path: "/api/desk/tools/backtests/strategy",
+            inputMode: "json_body",
+            schemas: {
+                request: "BacktestStrategyRequest",
+                response: "BacktestStrategyResponse",
+            },
+        },
+        cli: {
+            group: "backtests",
+            command: "info",
+            summary: "Mostra detalhes de uma estratégia de backtest.",
+            positional: [
+                {
+                    kind: "positional",
+                    name: "strategy_id",
+                    type: "string",
+                    required: true,
+                    placeholder: "ESTRATEGIA",
+                    description: "ID da estratégia retornado por `backtests strategies`.",
+                },
+            ],
+            options: [],
+            examples: ["quantbrasil backtests info ifr2"],
+        },
+        tool: {
+            name: "qb_backtests_info",
+            title: "Get backtest strategy info",
+        },
+        outputModes: standardOutputModes,
+    },
+    {
+        id: "backtests.get",
+        kind: "read",
+        visibility: publicRuntimeVisibility,
+        description: "Retorna um backtest salvo por ID, respeitando o usuário autenticado.",
+        http: {
+            method: "POST",
+            path: "/api/desk/tools/backtests/get",
+            inputMode: "json_body",
+            schemas: {
+                request: "BacktestGetRequest",
+                response: "BacktestGetResponse",
+            },
+        },
+        cli: {
+            group: "backtests",
+            command: "get",
+            summary: "Mostra um backtest salvo por ID.",
+            positional: [backtestIdPositional],
+            options: [],
+            examples: ["quantbrasil backtests get 123"],
+        },
+        tool: {
+            name: "qb_backtests_get",
+            title: "Get backtest",
+        },
+        outputModes: standardOutputModes,
+    },
+    {
+        id: "backtests.run",
+        kind: "mutation",
+        visibility: publicRuntimeVisibility,
+        description: "Executa um backtest para uma estratégia e ativo.",
+        http: {
+            method: "POST",
+            path: "/api/desk/tools/backtests/run",
+            inputMode: "json_body",
+            schemas: {
+                request: "BacktestRunRequest",
+                response: "BacktestRunResponse",
+            },
+        },
+        cli: {
+            group: "backtests",
+            command: "run",
+            summary: "Executa um backtest individual.",
+            positional: [
+                {
+                    kind: "positional",
+                    name: "strategy_id",
+                    type: "string",
+                    required: true,
+                    placeholder: "ESTRATEGIA",
+                    description: "ID da estratégia, por exemplo ifr2.",
+                },
+                {
+                    kind: "positional",
+                    name: "ticker",
+                    type: "string",
+                    required: true,
+                    placeholder: "TICKER",
+                    description: "Ticker do ativo, por exemplo PETR4.",
+                },
+            ],
+            options: [
+                {
+                    kind: "option",
+                    flag: "--timeframe",
+                    name: "timeframe_id",
+                    type: "enum",
+                    required: false,
+                    placeholder: "TIMEFRAME",
+                    enumValues: backtestTimeframeValues,
+                    description: "Timeframe do backtest.",
+                },
+                {
+                    kind: "option",
+                    flag: "--from",
+                    name: "start_date",
+                    type: "string",
+                    required: false,
+                    placeholder: "AAAA-MM-DD",
+                    description: "Data inicial em ISO.",
+                },
+                {
+                    kind: "option",
+                    flag: "--to",
+                    name: "end_date",
+                    type: "string",
+                    required: false,
+                    placeholder: "AAAA-MM-DD",
+                    description: "Data final em ISO.",
+                },
+                {
+                    kind: "option",
+                    flag: "--capital",
+                    name: "capital",
+                    type: "number",
+                    required: false,
+                    placeholder: "VALOR",
+                    description: "Capital inicial do backtest.",
+                },
+                {
+                    kind: "option",
+                    flag: "--max-risk",
+                    name: "max_risk",
+                    type: "number",
+                    required: false,
+                    placeholder: "VALOR",
+                    description: "Risco máximo do backtest.",
+                },
+                {
+                    kind: "option",
+                    flag: "--contracts",
+                    name: "num_contracts",
+                    type: "integer",
+                    required: false,
+                    placeholder: "N",
+                    defaultValue: 5,
+                    description: "Número de contratos para ativos que usam contratos.",
+                },
+                {
+                    kind: "option",
+                    flag: "--param",
+                    name: "parameters",
+                    type: "string_array",
+                    required: false,
+                    placeholder: "CHAVE=VALOR",
+                    multiple: true,
+                    collectionFormat: "repeatable",
+                    description: "Parâmetro da estratégia. Pode ser repetido, por exemplo --param rsi=30.",
+                },
+                {
+                    kind: "option",
+                    flag: "--params-json",
+                    name: "parameters_json",
+                    type: "string",
+                    required: false,
+                    placeholder: "JSON",
+                    description: "Objeto JSON com parâmetros da estratégia.",
+                },
+            ],
+            examples: [
+                "quantbrasil backtests run ifr2 PETR4 --timeframe D1 --from 2025-01-01 --to 2026-01-01",
+                "quantbrasil backtests run ifr2 PETR4 --timeframe D1 --param rsi=30 --param window=2 --json",
+            ],
+        },
+        tool: {
+            name: "qb_backtests_run",
+            title: "Run backtest",
+        },
+        outputModes: standardOutputModes,
+    },
+];

package/dist/vendor/core/capabilities/index.d.ts

@@ -2,6 +2,8 @@ export * from "./types.js";
 export * from "./shared.js";
 export * from "./market.js";
 export * from "./assets.js";
+export * from "./news.js";
+export * from "./backtests.js";
 export * from "./rankings.js";
 export * from "./screening.js";
 export * from "./portfolios.js";

package/dist/vendor/core/capabilities/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/capabilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/capabilities/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC"}

package/dist/vendor/core/capabilities/index.js

@@ -2,6 +2,8 @@ export * from "./types.js";
 export * from "./shared.js";
 export * from "./market.js";
 export * from "./assets.js";
+export * from "./news.js";
+export * from "./backtests.js";
 export * from "./rankings.js";
 export * from "./screening.js";
 export * from "./portfolios.js";

package/dist/vendor/core/capabilities/news.d.ts

@@ -0,0 +1,54 @@
+export declare const newsCapabilities: readonly [{
+    readonly id: "news.asset";
+    readonly kind: "read";
+    readonly visibility: readonly ["cli", "opencode"];
+    readonly description: "Retorna notícias recentes de RSS que mencionam diretamente um ativo da QuantBrasil.";
+    readonly http: {
+        readonly method: "POST";
+        readonly path: "/api/desk/tools/news/asset";
+        readonly inputMode: "json_body";
+        readonly schemas: {
+            readonly request: "AssetNewsRequest";
+            readonly response: "AssetNewsResponse";
+        };
+    };
+    readonly cli: {
+        readonly group: "news";
+        readonly command: "asset";
+        readonly summary: "Busca notícias recentes para um ticker.";
+        readonly positional: readonly [{
+            readonly kind: "positional";
+            readonly name: "ticker";
+            readonly type: "string";
+            readonly required: true;
+            readonly placeholder: "TICKER";
+            readonly description: "Ticker do ativo, por exemplo PETR4 ou VALE3.";
+        }];
+        readonly options: readonly [{
+            readonly kind: "option";
+            readonly flag: "--window";
+            readonly name: "window_days";
+            readonly type: "integer";
+            readonly required: false;
+            readonly placeholder: "DIAS";
+            readonly defaultValue: 30;
+            readonly description: "Janela de busca em dias.";
+        }, {
+            readonly kind: "option";
+            readonly flag: "--limit";
+            readonly name: "limit";
+            readonly type: "integer";
+            readonly required: false;
+            readonly placeholder: "N";
+            readonly defaultValue: 20;
+            readonly description: "Número máximo de notícias retornadas.";
+        }];
+        readonly examples: readonly ["quantbrasil news asset PETR4", "quantbrasil news asset PETR4 --window 7 --limit 10", "quantbrasil news asset PETR4 --json"];
+    };
+    readonly tool: {
+        readonly name: "qb_news_asset";
+        readonly title: "Buscar notícias do ativo";
+    };
+    readonly outputModes: readonly ["json", "human"];
+}];
+//# sourceMappingURL=news.d.ts.map

package/dist/vendor/core/capabilities/news.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"news.d.ts","sourceRoot":"","sources":["../../src/capabilities/news.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgEuB,CAAC"}

package/dist/vendor/core/capabilities/news.js

@@ -0,0 +1,65 @@
+import { publicRuntimeVisibility, standardOutputModes } from "./shared.js";
+export const newsCapabilities = [
+    {
+        id: "news.asset",
+        kind: "read",
+        visibility: publicRuntimeVisibility,
+        description: "Retorna notícias recentes de RSS que mencionam diretamente um ativo da QuantBrasil.",
+        http: {
+            method: "POST",
+            path: "/api/desk/tools/news/asset",
+            inputMode: "json_body",
+            schemas: {
+                request: "AssetNewsRequest",
+                response: "AssetNewsResponse",
+            },
+        },
+        cli: {
+            group: "news",
+            command: "asset",
+            summary: "Busca notícias recentes para um ticker.",
+            positional: [
+                {
+                    kind: "positional",
+                    name: "ticker",
+                    type: "string",
+                    required: true,
+                    placeholder: "TICKER",
+                    description: "Ticker do ativo, por exemplo PETR4 ou VALE3.",
+                },
+            ],
+            options: [
+                {
+                    kind: "option",
+                    flag: "--window",
+                    name: "window_days",
+                    type: "integer",
+                    required: false,
+                    placeholder: "DIAS",
+                    defaultValue: 30,
+                    description: "Janela de busca em dias.",
+                },
+                {
+                    kind: "option",
+                    flag: "--limit",
+                    name: "limit",
+                    type: "integer",
+                    required: false,
+                    placeholder: "N",
+                    defaultValue: 20,
+                    description: "Número máximo de notícias retornadas.",
+                },
+            ],
+            examples: [
+                "quantbrasil news asset PETR4",
+                "quantbrasil news asset PETR4 --window 7 --limit 10",
+                "quantbrasil news asset PETR4 --json",
+            ],
+        },
+        tool: {
+            name: "qb_news_asset",
+            title: "Buscar notícias do ativo",
+        },
+        outputModes: standardOutputModes,
+    },
+];