lf-cli 1.0.0

data/lib/langfuse/cli/formatters/csv_formatter.rb

@@ -0,0 +1,46 @@
+require 'csv'
+require 'json'
+
+module Langfuse
+  module CLI
+    module Formatters
+      class CSVFormatter
+        def self.format(data)
+          return "No data to display" if data.nil? || (data.is_a?(Array) && data.empty?)
+
+          # Convert single hash to array for consistent handling
+          data = [data] unless data.is_a?(Array)
+
+          # Get all unique keys from all rows
+          headers = data.flat_map(&:keys).uniq
+
+          # Generate CSV
+          CSV.generate do |csv|
+            # Add headers
+            csv << headers
+
+            # Add data rows
+            data.each do |row|
+              csv << headers.map { |header| format_value(row[header]) }
+            end
+          end
+        end
+
+        private
+
+        def self.format_value(value)
+          case value
+          when nil
+            ''
+          when Hash, Array
+            value.to_json
+          when Time, DateTime
+            value.iso8601
+          else
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/langfuse/cli/formatters/markdown_formatter.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module Langfuse
+  module CLI
+    module Formatters
+      class MarkdownFormatter
+        def self.format(data)
+          return "No data to display" if data.nil? || (data.is_a?(Array) && data.empty?)
+
+          # Convert single hash to array for consistent handling
+          data = [data] unless data.is_a?(Array)
+
+          # Get all unique keys from all rows
+          headers = data.flat_map(&:keys).uniq
+
+          # Build markdown table
+          output = []
+
+          # Header row
+          output << "| #{headers.join(' | ')} |"
+
+          # Separator row
+          output << "| #{headers.map { '---' }.join(' | ')} |"
+
+          # Data rows
+          data.each do |row|
+            values = headers.map { |header| escape_pipes(format_value(row[header])) }
+            output << "| #{values.join(' | ')} |"
+          end
+
+          output.join("\n")
+        end
+
+        private
+
+        def self.format_value(value)
+          case value
+          when nil
+            ''
+          when Hash, Array
+            value.to_json
+          when Time, DateTime
+            value.iso8601
+          else
+            value.to_s
+          end
+        end
+
+        def self.escape_pipes(str)
+          # Escape pipe characters for markdown tables
+          str.gsub('|', '\\|')
+        end
+      end
+    end
+  end
+end

data/lib/langfuse/cli/formatters/table_formatter.rb

@@ -0,0 +1,43 @@
+require 'terminal-table'
+
+module Langfuse
+  module CLI
+    module Formatters
+      class TableFormatter
+        def self.format(data)
+          return "No data to display" if data.nil? || (data.is_a?(Array) && data.empty?)
+
+          # Convert single hash to array for consistent handling
+          data = [data] unless data.is_a?(Array)
+
+          # Get all unique keys from all rows
+          headers = data.flat_map(&:keys).uniq
+
+          # Build rows
+          rows = data.map do |row|
+            headers.map { |header| format_value(row[header]) }
+          end
+
+          # Create table
+          table = Terminal::Table.new(headings: headers, rows: rows)
+          table.to_s
+        end
+
+        private
+
+        def self.format_value(value)
+          case value
+          when nil
+            ''
+          when Hash, Array
+            value.to_json
+          when Time, DateTime
+            value.iso8601
+          else
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/langfuse/cli/types.rb

@@ -0,0 +1,98 @@
+require 'sorbet-runtime'
+
+module Langfuse
+  module CLI
+    module Types
+      # Enum for metrics view types
+      class MetricsView < T::Enum
+        enums do
+          Traces = new('traces')
+          Observations = new('observations')
+          ScoresNumeric = new('scores-numeric')
+          ScoresCategorical = new('scores-categorical')
+        end
+      end
+
+      # Enum for measure types
+      class Measure < T::Enum
+        enums do
+          Count = new('count')
+          Latency = new('latency')
+          Value = new('value')
+          Tokens = new('tokens')
+          Cost = new('cost')
+        end
+      end
+
+      # Enum for aggregation functions
+      class Aggregation < T::Enum
+        enums do
+          Count = new('count')
+          Sum = new('sum')
+          Avg = new('avg')
+          P50 = new('p50')
+          P95 = new('p95')
+          P99 = new('p99')
+          Min = new('min')
+          Max = new('max')
+          Histogram = new('histogram')
+        end
+      end
+
+      # Enum for time granularity
+      class TimeGranularity < T::Enum
+        enums do
+          Minute = new('minute')
+          Hour = new('hour')
+          Day = new('day')
+          Week = new('week')
+          Month = new('month')
+          Auto = new('auto')
+        end
+      end
+
+      # Enum for observation types
+      class ObservationType < T::Enum
+        enums do
+          Generation = new('generation')
+          Span = new('span')
+          Event = new('event')
+        end
+      end
+
+      # Enum for output formats
+      class OutputFormat < T::Enum
+        enums do
+          Table = new('table')
+          JSON = new('json')
+          CSV = new('csv')
+          Markdown = new('markdown')
+        end
+      end
+
+      # Struct for metrics query parameters
+      class MetricsQuery < T::Struct
+        const :view, String
+        const :measure, String
+        const :aggregation, String
+        prop :dimensions, T.nilable(T::Array[String]), default: nil
+        prop :from_timestamp, T.nilable(String), default: nil
+        prop :to_timestamp, T.nilable(String), default: nil
+        prop :granularity, T.nilable(String), default: nil
+        prop :limit, T.nilable(Integer), default: 100
+
+        def to_h
+          {
+            'view' => view,
+            'metrics' => [{ 'measure' => measure, 'aggregation' => aggregation }],
+            'dimensions' => dimensions&.map { |d| { 'field' => d } },
+            'fromTimestamp' => from_timestamp,
+            'toTimestamp' => to_timestamp,
+            'timeDimension' => granularity ? { 'granularity' => granularity } : nil,
+            'limit' => limit
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/langfuse/cli/version.rb

@@ -0,0 +1,5 @@
+module Langfuse
+  module CLI
+    VERSION = "1.0.0"
+  end
+end

data/lib/langfuse/cli.rb

@@ -0,0 +1,142 @@
+require 'thor'
+require_relative 'cli/version'
+require_relative 'cli/config'
+require_relative 'cli/client'
+require_relative 'cli/commands/traces'
+require_relative 'cli/commands/sessions'
+require_relative 'cli/commands/observations'
+require_relative 'cli/commands/scores'
+require_relative 'cli/commands/metrics'
+require_relative 'cli/commands/config'
+
+module Langfuse
+  module CLI
+
+    class Main < Thor
+      class << self
+        def exit_on_failure?
+          true
+        end
+      end
+
+      # Global options that apply to all commands
+      class_option :profile,
+                   type: :string,
+                   aliases: '-P',
+                   desc: 'Config profile to use'
+      class_option :format,
+                   type: :string,
+                   aliases: '-f',
+                   enum: %w[table json csv markdown],
+                   default: 'table',
+                   desc: 'Output format'
+      class_option :output,
+                   type: :string,
+                   aliases: '-o',
+                   desc: 'Output file path (defaults to stdout)'
+      class_option :limit,
+                   type: :numeric,
+                   aliases: '-l',
+                   desc: 'Limit number of results'
+      class_option :page,
+                   type: :numeric,
+                   aliases: '-p',
+                   desc: 'Page number for pagination'
+      class_option :host,
+                   type: :string,
+                   desc: 'Langfuse host URL'
+      class_option :public_key,
+                   type: :string,
+                   desc: 'Langfuse public key'
+      class_option :secret_key,
+                   type: :string,
+                   desc: 'Langfuse secret key'
+      class_option :verbose,
+                   type: :boolean,
+                   aliases: '-v',
+                   default: false,
+                   desc: 'Verbose output'
+      class_option :no_color,
+                   type: :boolean,
+                   default: false,
+                   desc: 'Disable colored output'
+
+      desc 'version', 'Show version'
+      def version
+        puts "lf-cli version #{Langfuse::CLI::VERSION}"
+      end
+
+      desc 'traces SUBCOMMAND ...ARGS', 'Manage traces'
+      subcommand 'traces', Commands::Traces
+
+      desc 'sessions SUBCOMMAND ...ARGS', 'Manage sessions'
+      subcommand 'sessions', Commands::Sessions
+
+      desc 'observations SUBCOMMAND ...ARGS', 'Manage observations'
+      subcommand 'observations', Commands::Observations
+
+      desc 'metrics SUBCOMMAND ...ARGS', 'Query metrics'
+      subcommand 'metrics', Commands::Metrics
+
+      desc 'scores SUBCOMMAND ...ARGS', 'Manage scores'
+      subcommand 'scores', Commands::Scores
+
+      desc 'config SUBCOMMAND ...ARGS', 'Manage configuration'
+      subcommand 'config', Commands::ConfigCommand
+
+      private
+
+      def client
+        @client ||= begin
+          config = load_config
+          unless config.valid?
+            error_message = "Missing required configuration: #{config.missing_fields.join(', ')}"
+            error_message += "\n\nPlease set environment variables or run: langfuse config setup"
+            raise Error, error_message
+          end
+          Client.new(config)
+        end
+      end
+
+      def load_config
+        Config.new(
+          profile: options[:profile],
+          public_key: options[:public_key],
+          secret_key: options[:secret_key],
+          host: options[:host],
+          format: options[:format],
+          limit: options[:limit]
+        )
+      end
+
+      def output_result(data)
+        formatted = format_output(data)
+
+        if options[:output]
+          File.write(options[:output], formatted)
+          puts "Output written to #{options[:output]}" if options[:verbose]
+        else
+          puts formatted
+        end
+      end
+
+      def format_output(data)
+        case options[:format]
+        when 'json'
+          require 'json'
+          JSON.pretty_generate(data)
+        when 'csv'
+          # CSV formatting will be implemented in formatters
+          require_relative 'cli/formatters/csv_formatter'
+          Formatters::CSVFormatter.format(data)
+        when 'markdown'
+          require_relative 'cli/formatters/markdown_formatter'
+          Formatters::MarkdownFormatter.format(data)
+        else # table
+          require_relative 'cli/formatters/table_formatter'
+          Formatters::TableFormatter.format(data)
+        end
+      end
+    end
+  end
+end

data/lib/langfuse_cli.rb

@@ -0,0 +1,10 @@
+require "langfuse/cli/version"
+require "langfuse/cli/config"
+require "langfuse/cli/client"
+require "langfuse/cli"
+
+module Langfuse
+  module CLI
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,303 @@
+--- !ruby/object:Gem::Specification
+name: lf-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vicente Reig Rincon de Arellano
+bindir: bin
+cert_chain: []
+date: 2025-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: Unofficial command-line interface for querying and analyzing Langfuse
+  LLM observability data. This is a community project not affiliated with Langfuse
+  GmbH.
+email:
+- hey@vicente.services
+executables:
+- lf
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/lf
+- lib/langfuse/cli.rb
+- lib/langfuse/cli/client.rb
+- lib/langfuse/cli/commands/config.rb
+- lib/langfuse/cli/commands/metrics.rb
+- lib/langfuse/cli/commands/observations.rb
+- lib/langfuse/cli/commands/scores.rb
+- lib/langfuse/cli/commands/sessions.rb
+- lib/langfuse/cli/commands/traces.rb
+- lib/langfuse/cli/config.rb
+- lib/langfuse/cli/formatters/csv_formatter.rb
+- lib/langfuse/cli/formatters/markdown_formatter.rb
+- lib/langfuse/cli/formatters/table_formatter.rb
+- lib/langfuse/cli/types.rb
+- lib/langfuse/cli/version.rb
+- lib/langfuse_cli.rb
+homepage: https://github.com/vicentereig/lf-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vicentereig/lf-cli
+  source_code_uri: https://github.com/vicentereig/lf-cli
+  changelog_uri: https://github.com/vicentereig/lf-cli/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: An open-source CLI for Langfuse®
+test_files: []