ticker-cli 1.0.0

package/src/commands/indicator.ts

@@ -0,0 +1,152 @@
+import { Command } from "commander";
+import { createYahooService, createIndicatorService } from "../services";
+import { createFormatter, isValidPeriod } from "../utils";
+import type { PeriodPreset } from "../types";
+
+const AVAILABLE_INDICATORS = ["sma", "ema", "rsi", "macd", "bb"] as const;
+
+/**
+ * Create the indicator command
+ */
+export function createIndicatorCommand(): Command {
+  const command = new Command("indicator");
+
+  command
+    .description(
+      `Calculate technical indicators. Available: ${AVAILABLE_INDICATORS.join(", ")}`,
+    )
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .argument(
+      "<indicator>",
+      `Indicator type: ${AVAILABLE_INDICATORS.join(", ")}`,
+    )
+    .option(
+      "-p, --period <period>",
+      "Preset period for historical data: 1d, 5d, 1wk, 1mo, 3mo, 6mo, 1y, 2y, 5y",
+      "3mo",
+    )
+    .option("-s, --start <date>", "Start date (YYYY-MM-DD)")
+    .option("-e, --end <date>", "End date (YYYY-MM-DD)")
+    .option(
+      "--length <number>",
+      "Period length for SMA/EMA/RSI/BB (default: 20 for SMA/EMA/BB, 14 for RSI)",
+    )
+    .option("--short <number>", "Short period for MACD (default: 12)")
+    .option("--long <number>", "Long period for MACD (default: 26)")
+    .option("--signal <number>", "Signal period for MACD (default: 9)")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        indicator: string,
+        options: {
+          period?: string;
+          start?: string;
+          end?: string;
+          length?: string;
+          short?: string;
+          long?: string;
+          signal?: string;
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const indicatorService = createIndicatorService();
+        const formatter = createFormatter(options);
+
+        // Validate indicator
+        const normalizedIndicator = indicator.toLowerCase();
+        if (
+          !AVAILABLE_INDICATORS.includes(
+            normalizedIndicator as (typeof AVAILABLE_INDICATORS)[number],
+          )
+        ) {
+          console.error(
+            `Invalid indicator: ${indicator}. Available: ${AVAILABLE_INDICATORS.join(", ")}`,
+          );
+          process.exit(1);
+        }
+
+        // Validate period
+        let period: PeriodPreset | undefined;
+        if (options.period) {
+          if (!isValidPeriod(options.period)) {
+            console.error(
+              `Invalid period: ${options.period}. Valid options: 1d, 5d, 1wk, 1mo, 3mo, 6mo, 1y, 2y, 5y`,
+            );
+            process.exit(1);
+          }
+          period = options.period as PeriodPreset;
+        }
+
+        // Parse numeric options
+        const config: {
+          length?: number;
+          short?: number;
+          long?: number;
+          signal?: number;
+        } = {};
+
+        if (options.length) {
+          config.length = parseInt(options.length, 10);
+          if (isNaN(config.length)) {
+            console.error("Invalid length value");
+            process.exit(1);
+          }
+        }
+        if (options.short) {
+          config.short = parseInt(options.short, 10);
+          if (isNaN(config.short)) {
+            console.error("Invalid short value");
+            process.exit(1);
+          }
+        }
+        if (options.long) {
+          config.long = parseInt(options.long, 10);
+          if (isNaN(config.long)) {
+            console.error("Invalid long value");
+            process.exit(1);
+          }
+        }
+        if (options.signal) {
+          config.signal = parseInt(options.signal, 10);
+          if (isNaN(config.signal)) {
+            console.error("Invalid signal value");
+            process.exit(1);
+          }
+        }
+
+        try {
+          // Fetch chart data
+          const chartData = await yahooService.getChart(symbol, {
+            period,
+            start: options.start,
+            end: options.end,
+          });
+
+          // Calculate indicator
+          const indicatorResult = indicatorService.calculate(
+            normalizedIndicator,
+            chartData.quotes,
+            config,
+          );
+
+          // Add symbol to result
+          indicatorResult.symbol = symbol;
+
+          const output = formatter.format(indicatorResult);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error calculating indicator:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/insights.ts

@@ -0,0 +1,42 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the insights command
+ */
+export function createInsightsCommand(): Command {
+  const command = new Command("insights");
+
+  command
+    .description("Get insights for a symbol")
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        options: {
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        try {
+          const insights = await yahooService.getInsights(symbol);
+          const output = formatter.format(insights);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error fetching insights:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/news.ts

@@ -0,0 +1,46 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the news command
+ */
+export function createNewsCommand(): Command {
+  const command = new Command("news");
+
+  command
+    .description("Get news for a symbol")
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .option("-l, --limit <number>", "Number of news articles", "10")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        options: {
+          limit?: string;
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        const limit = options.limit ? parseInt(options.limit, 10) : 10;
+
+        try {
+          const news = await yahooService.getNews(symbol, limit);
+          const output = formatter.format(news);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error fetching news:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/options.ts

@@ -0,0 +1,69 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the options command
+ */
+export function createOptionsCommand(): Command {
+  const command = new Command("options");
+
+  command
+    .description("Get options chain for a symbol")
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .option("-d, --date <date>", "Expiration date (YYYY-MM-DD)")
+    .option("--calls", "Show only calls")
+    .option("--puts", "Show only puts")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        options: {
+          date?: string;
+          calls?: boolean;
+          puts?: boolean;
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        try {
+          const optionsData = await yahooService.getOptions(
+            symbol,
+            options.date,
+          );
+
+          // Filter calls/puts if requested
+          if (options.calls && !options.puts) {
+            const output = formatter.format({
+              symbol: optionsData.symbol,
+              expirationDate: optionsData.expirationDate,
+              calls: optionsData.calls,
+            });
+            console.log(output);
+          } else if (options.puts && !options.calls) {
+            const output = formatter.format({
+              symbol: optionsData.symbol,
+              expirationDate: optionsData.expirationDate,
+              puts: optionsData.puts,
+            });
+            console.log(output);
+          } else {
+            const output = formatter.format(optionsData);
+            console.log(output);
+          }
+        } catch (error) {
+          console.error(
+            "Error fetching options:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/quote.ts

@@ -0,0 +1,34 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the quote command
+ */
+export function createQuoteCommand(): Command {
+  const command = new Command("quote");
+
+  command
+    .description("Get stock quotes for one or more symbols")
+    .argument("<symbols...>", "Stock symbols (e.g., AAPL MSFT GOOGL)")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(async (symbols: string[], options: { table?: boolean; pretty?: boolean }) => {
+      const yahooService = createYahooService();
+      const formatter = createFormatter(options);
+
+      try {
+        const quotes = await yahooService.getQuotes(symbols);
+        const output = formatter.format({ quotes });
+        console.log(output);
+      } catch (error) {
+        console.error(
+          "Error fetching quotes:",
+          error instanceof Error ? error.message : String(error)
+        );
+        process.exit(1);
+      }
+    });
+
+  return command;
+}

package/src/commands/recommendations.ts

@@ -0,0 +1,42 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the recommendations command
+ */
+export function createRecommendationsCommand(): Command {
+  const command = new Command("recommendations");
+
+  command
+    .description("Get analyst recommendations for a symbol")
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        options: {
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        try {
+          const recommendations = await yahooService.getRecommendations(symbol);
+          const output = formatter.format(recommendations);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error fetching recommendations:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/screener.ts

@@ -0,0 +1,58 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+import type { PredefinedScreenerModules } from "yahoo-finance2/modules/screener";
+
+const PREDEFINED_QUERIES: PredefinedScreenerModules[] = [
+  "most_actives",
+  "day_gainers",
+  "day_losers",
+  "undervalued_growth_stocks",
+  "undervalued_large_caps",
+  "growth_technology_stocks",
+  "top_mutual_funds",
+];
+
+/**
+ * Create the screener command
+ */
+export function createScreenerCommand(): Command {
+  const command = new Command("screener");
+
+  command
+    .description("Screen stocks using predefined queries")
+    .option(
+      "-q, --query <query>",
+      `Predefined query: ${PREDEFINED_QUERIES.join(", ")}`,
+      "most_actives",
+    )
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (options: {
+        query?: string;
+        table?: boolean;
+        pretty?: boolean;
+      }) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        const query = (options.query ??
+          "most_actives") as PredefinedScreenerModules;
+
+        try {
+          const screenerData = await yahooService.getScreener(query);
+          const output = formatter.format(screenerData);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error fetching screener data:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/search.ts

@@ -0,0 +1,49 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+
+/**
+ * Create the search command
+ */
+export function createSearchCommand(): Command {
+  const command = new Command("search");
+
+  command
+    .description("Search for stock symbols")
+    .argument("<query>", "Search query (e.g., apple)")
+    .option("--quotes", "Include quotes in results")
+    .option("--news", "Include news in results")
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        query: string,
+        options: {
+          quotes?: boolean;
+          news?: boolean;
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        try {
+          const result = await yahooService.search(query, {
+            includeQuotes: options.quotes,
+            includeNews: options.news,
+          });
+          const output = formatter.format(result);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error searching symbols:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/commands/summary.ts

@@ -0,0 +1,50 @@
+import { Command } from "commander";
+import { createYahooService } from "../services";
+import { createFormatter } from "../utils";
+import type { QuoteSummaryModules } from "yahoo-finance2/modules/quoteSummary";
+
+/**
+ * Create the summary command
+ */
+export function createSummaryCommand(): Command {
+  const command = new Command("summary");
+
+  command
+    .description("Get quote summary for a symbol")
+    .argument("<symbol>", "Stock symbol (e.g., AAPL)")
+    .option(
+      "-m, --modules <modules>",
+      "Comma-separated modules to include (e.g., summaryProfile,summaryDetail)",
+    )
+    .option("--table", "Output as table instead of JSON")
+    .option("--pretty", "Pretty print JSON output", true)
+    .action(
+      async (
+        symbol: string,
+        options: {
+          modules?: string;
+          table?: boolean;
+          pretty?: boolean;
+        },
+      ) => {
+        const yahooService = createYahooService();
+        const formatter = createFormatter(options);
+
+        const modules = options.modules?.split(",").map((m) => m.trim() as QuoteSummaryModules);
+
+        try {
+          const summary = await yahooService.getSummary(symbol, modules);
+          const output = formatter.format(summary);
+          console.log(output);
+        } catch (error) {
+          console.error(
+            "Error fetching summary:",
+            error instanceof Error ? error.message : String(error),
+          );
+          process.exit(1);
+        }
+      },
+    );
+
+  return command;
+}

package/src/services/index.ts

@@ -0,0 +1,3 @@
+export { YahooService, createYahooService } from "./yahoo";
+export { IndicatorService, createIndicatorService } from "./indicators";
+export type { IndicatorConfig } from "./indicators";