lf-cli 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14d28df3a9c60a7b537c3a808b62cde87c7c3a475bd0b09351dd9256349fe41e
-  data.tar.gz: 220ff83b225a5b7d1f09572e5d29d23d21f86f3e6623a2666f4164e8985aeecd
+  metadata.gz: 06ff677435b9202de2481d4aa72805639508431a90805be2d0adbb50e54bbcff
+  data.tar.gz: 425bcfc9371f4c6c497f50b2082f0d54e7d0a85b7fcd737988ff60d7f9edfac2
 SHA512:
-  metadata.gz: 1332550a6e5beb94c1ec966f1e2adacf84d68cb0ec4656387e0608f71be83dddd444e4792083ad3728d6ec0bef1e00f0fae46afe650c118d7f61137393bbb0c0
-  data.tar.gz: 0ad77d7fd57a2c758d3c2521d501a699601ba161bc01136f0539cd0d1254e067d2de1a5d489751db0b770775afbfd8a4a2f775eb772fde7f421291b407b689ed
+  metadata.gz: 64c05599e12dc8ee8f9a414519d14f5912dddfa969a0cfaaaf7c5f81bb689a7c7587de7886716739bfb2e82d04063447655f840b9c9c9577d6d4fa7875c98600
+  data.tar.gz: 345323d04554a45007cff5936ff300dd8df0d29dcca874fd155122a94150b2b4c1f8f224d279c7c405924edefd838b59faf343b9c6f9cf5ca60615ef8a356a32

data/CHANGELOG.md

@@ -14,6 +14,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Creating/updating scores via CLI
 - Integration with other observability tools
 
+## [1.0.2] - 2026-02-11
+
+### Changed
+- `json` is now the default output format for all commands.
+- Removed `markdown` as a supported output format.
+- `lf traces get` now always returns an `observations` field in output.
+
+### Removed
+- Removed `--with-observations` / `--no-with-observations` from `lf traces get`.
+
 ## [1.0.1] - 2026-02-10
 
 ### Added

data/README.md

@@ -21,7 +21,7 @@ This project is not affiliated with, endorsed by, or sponsored by Langfuse GmbH.
 - 🎯 **Inspect Observations** - List LLM generations, spans, and events
 - 📈 **Query Metrics** - Run analytics queries with custom aggregations and dimensions
 - ⭐ **View Scores** - Access quality scores and evaluation metrics
-- 🎨 **Multiple Output Formats** - Table, JSON, CSV, or Markdown
+- 🎨 **Multiple Output Formats** - JSON, Table, or CSV
 - 🔐 **Multi-Profile Support** - Manage credentials for dev, staging, and production
 - 🌐 **Interactive Setup** - Browser-integrated credential configuration
 - ⚡ **Type-Safe** - Built with Sorbet Runtime for reliability
@@ -191,7 +191,7 @@ lf metrics query \
 All commands support these global options:
 
 ```bash
--f, --format [table|json|csv|markdown]   # Output format (default: table)
+-f, --format [json|table|csv]            # Output format (default: json)
 -o, --output FILE                        # Save output to file
 -l, --limit N                            # Limit number of results
 -P, --profile PROFILE                    # Use specific profile
@@ -216,21 +216,21 @@ Supports both ISO 8601 and natural language:
 
 ## Output Formats
 
-### Table (Default)
+### JSON (Default)
 
 ```bash
-lf traces list --format table
+lf traces list --format json
 ```
 
-Outputs a formatted ASCII table - great for terminal viewing.
+Perfect for piping to `jq` or other tools.
 
-### JSON
+### Table
 
 ```bash
-lf traces list --format json
+lf traces list --format table
 ```
 
-Perfect for piping to `jq` or other tools:
+Outputs a formatted ASCII table - great for terminal viewing.
 
 ```bash
 lf traces list --format json | jq '.[] | select(.name == "chat")'
@@ -244,14 +244,6 @@ lf traces list --format csv --output data.csv
 
 Import into spreadsheets or data analysis tools.
 
-### Markdown
-
-```bash
-lf traces list --format markdown
-```
-
-Great for documentation and reports.
-
 ## Configuration
 
 ### Configuration File
@@ -264,7 +256,7 @@ profiles:
     host: https://cloud.langfuse.com
     public_key: pk_...
     secret_key: sk_...
-    output_format: table
+    output_format: json
     page_limit: 50
 
   production:
@@ -337,7 +329,7 @@ This section mirrors the depth of a `llms-full.txt` so AI assistants can answer
 | `-P, --profile PROFILE` | Selects a saved profile. | Defaults to `default`. |
 | `--public-key KEY` / `--secret-key KEY` | Inject credentials without touching config files. | Highest priority source. |
 | `--host URL` | Override Langfuse host. | Combine with `--profile` to temporarily test another region. |
-| `-f, --format FORMAT` | `table` (default), `json`, `csv`, `markdown`. | Applies to every command; CSV/Markdown require structured arrays. |
+| `-f, --format FORMAT` | `json` (default), `table`, `csv`. | Applies to every command. |
 | `-o, --output PATH` | Write output to a file. | Respects format; prints “Output written…” when `--verbose`. |
 | `-l, --limit N` | Caps number of records pulled per command. | Pagination helper, defaults to API `limit` (50) when omitted. |
 | `-p, --page N` | Start from an explicit page. | Useful when you know an offset. |
@@ -350,9 +342,8 @@ Pagination strategy: the client keeps fetching pages until it collects the reque
 ### Output & Files
 
 - `table` renders ASCII tables via `Formatters::TableFormatter` and truncates oversized cells for terminal safety.
-- `json` prints pretty JSON to stdout for direct piping to `jq`.
-- `csv` and `markdown` use dedicated formatters and require array-like data (single hashes are wrapped automatically).
-- `markdown` escapes pipes, normalizes newlines to `<br>`, and truncates oversized cells.
+- `json` is the default output and prints pretty JSON to stdout for direct piping to `jq`.
+- `csv` uses a dedicated formatter and requires array-like data (single hashes are wrapped automatically).
 - `--output` writes to a file; JSON output is written in compact form to reduce memory pressure on large payloads.
 - Use `lf ... --format json | jq ...` for automation recipes.
 
@@ -374,7 +365,7 @@ Each command inherits the global flags above. API errors exit with status code `
 | Subcommand | Purpose |
 | --- | --- |
 | `lf traces list` | Lists traces with filters/pagination. |
-| `lf traces get TRACE_ID [--with-observations]` | Fetches a single trace. The `--with-observations` flag is accepted for forward compatibility but currently behaves the same as the default API payload. |
+| `lf traces get TRACE_ID` | Fetches a single trace with `observations` included. |
 
 `traces list` options:
 
@@ -522,7 +513,6 @@ lib/langfuse/cli/
 ├── formatters/         # Output formatters
 │   ├── table_formatter.rb
 │   ├── csv_formatter.rb
-│   └── markdown_formatter.rb
 └── commands/           # Command modules
     ├── traces.rb
     ├── sessions.rb

data/lib/langfuse/cli/commands/metrics.rb

@@ -146,7 +146,7 @@ module Langfuse
         end
 
         def output_result(data)
-          format_type = parent_options[:format] || 'table'
+          format_type = parent_options[:format] || 'json'
 
           if parent_options[:output]
             write_output(parent_options[:output], data, format_type)
@@ -156,16 +156,13 @@ module Langfuse
           end
         end
 
-        def format_output(data, format_type: 'table')
+        def format_output(data, format_type: 'json')
           case format_type
           when 'json'
             JSON.pretty_generate(data)
           when 'csv'
             require_relative '../formatters/csv_formatter'
             Formatters::CSVFormatter.format(data)
-          when 'markdown'
-            require_relative '../formatters/markdown_formatter'
-            Formatters::MarkdownFormatter.format(data)
           else # table
             require_relative '../formatters/table_formatter'
             Formatters::TableFormatter.format(data)

data/lib/langfuse/cli/commands/observations.rb

@@ -112,7 +112,7 @@ module Langfuse
         end
 
         def output_result(data)
-          format_type = parent_options[:format] || 'table'
+          format_type = parent_options[:format] || 'json'
 
           if parent_options[:output]
             write_output(parent_options[:output], data, format_type)
@@ -122,16 +122,13 @@ module Langfuse
           end
         end
 
-        def format_output(data, format_type: 'table')
+        def format_output(data, format_type: 'json')
           case format_type
           when 'json'
             JSON.pretty_generate(data)
           when 'csv'
             require_relative '../formatters/csv_formatter'
             Formatters::CSVFormatter.format(data)
-          when 'markdown'
-            require_relative '../formatters/markdown_formatter'
-            Formatters::MarkdownFormatter.format(data)
           else # table
             require_relative '../formatters/table_formatter'
             Formatters::TableFormatter.format(data)

data/lib/langfuse/cli/commands/scores.rb

@@ -73,7 +73,7 @@ module Langfuse
         end
 
         def output_result(data)
-          format_type = parent_options[:format] || 'table'
+          format_type = parent_options[:format] || 'json'
 
           if parent_options[:output]
             write_output(parent_options[:output], data, format_type)
@@ -83,16 +83,13 @@ module Langfuse
           end
         end
 
-        def format_output(data, format_type: 'table')
+        def format_output(data, format_type: 'json')
           case format_type
           when 'json'
             JSON.pretty_generate(data)
           when 'csv'
             require_relative '../formatters/csv_formatter'
             Formatters::CSVFormatter.format(data)
-          when 'markdown'
-            require_relative '../formatters/markdown_formatter'
-            Formatters::MarkdownFormatter.format(data)
           else # table
             require_relative '../formatters/table_formatter'
             Formatters::TableFormatter.format(data)

data/lib/langfuse/cli/commands/sessions.rb

@@ -72,7 +72,7 @@ module Langfuse
         end
 
         def output_result(data)
-          format_type = parent_options[:format] || 'table'
+          format_type = parent_options[:format] || 'json'
 
           if parent_options[:output]
             write_output(parent_options[:output], data, format_type)
@@ -82,16 +82,13 @@ module Langfuse
           end
         end
 
-        def format_output(data, format_type: 'table')
+        def format_output(data, format_type: 'json')
           case format_type
           when 'json'
             JSON.pretty_generate(data)
           when 'csv'
             require_relative '../formatters/csv_formatter'
             Formatters::CSVFormatter.format(data)
-          when 'markdown'
-            require_relative '../formatters/markdown_formatter'
-            Formatters::MarkdownFormatter.format(data)
           else # table
             require_relative '../formatters/table_formatter'
             Formatters::TableFormatter.format(data)

data/lib/langfuse/cli/commands/traces.rb

@@ -29,7 +29,7 @@ module Langfuse
             --from, --to: Time range (ISO 8601 or relative like "1 hour ago")
 
           OUTPUT OPTIONS:
-            Global options: --format [table|json|csv|markdown], --output FILE
+            Global options: --format [json|table|csv], --output FILE
 
           EXAMPLES:
 
@@ -66,11 +66,10 @@ module Langfuse
           raise_cli_error("Error: #{e.message}")
         end
 
-        desc 'get TRACE_ID', 'Get a specific trace'
-        option :with_observations, type: :boolean, default: false, desc: 'Include all observations'
+        desc 'get TRACE_ID', 'Get a specific trace with observations'
         def get(trace_id)
           trace = client.get_trace(trace_id)
-          output_result(trace)
+          output_result(ensure_observations(trace))
         rescue Client::NotFoundError => _e
           raise_cli_error("Trace not found - #{trace_id}")
         rescue Client::APIError => e
@@ -116,7 +115,7 @@ module Langfuse
         end
 
         def output_result(data)
-          format_type = parent_options[:format] || 'table'
+          format_type = parent_options[:format] || 'json'
 
           if parent_options[:output]
             write_output(parent_options[:output], data, format_type)
@@ -126,16 +125,13 @@ module Langfuse
           end
         end
 
-        def format_output(data, format_type: 'table')
+        def format_output(data, format_type: 'json')
           case format_type
           when 'json'
             JSON.pretty_generate(data)
           when 'csv'
             require_relative '../formatters/csv_formatter'
             Formatters::CSVFormatter.format(data)
-          when 'markdown'
-            require_relative '../formatters/markdown_formatter'
-            Formatters::MarkdownFormatter.format(data)
           else # table
             require_relative '../formatters/table_formatter'
             Formatters::TableFormatter.format(data)
@@ -150,6 +146,12 @@ module Langfuse
           end
         end
 
+        def ensure_observations(trace)
+          return trace unless trace.is_a?(Hash)
+
+          trace.merge('observations' => trace['observations'] || [])
+        end
+
         def parent_options
           @parent_options ||= begin
             # Try to get parent options from Thor

data/lib/langfuse/cli/config.rb

@@ -10,7 +10,7 @@ module Langfuse
       attr_accessor :public_key, :secret_key, :host, :profile, :output_format, :page_limit
 
       DEFAULT_HOST = 'https://cloud.langfuse.com'
-      DEFAULT_OUTPUT_FORMAT = 'table'
+      DEFAULT_OUTPUT_FORMAT = 'json'
       DEFAULT_PAGE_LIMIT = 50
       CONFIG_DIR = File.expand_path('~/.langfuse')
       CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')

data/lib/langfuse/cli/types.rb

@@ -66,7 +66,6 @@ module Langfuse
           Table = new('table')
           JSON = new('json')
           CSV = new('csv')
-          Markdown = new('markdown')
         end
       end
 

data/lib/langfuse/cli/version.rb

@@ -1,5 +1,5 @@
 module Langfuse
   module CLI
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/langfuse/cli.rb

@@ -28,8 +28,8 @@ module Langfuse
       class_option :format,
                    type: :string,
                    aliases: '-f',
-                   enum: %w[table json csv markdown],
-                   default: 'table',
+                   enum: %w[json table csv],
+                   default: 'json',
                    desc: 'Output format'
       class_option :output,
                    type: :string,
@@ -111,7 +111,7 @@ module Langfuse
       end
 
       def output_result(data)
-        format_type = options[:format] || 'table'
+        format_type = options[:format] || 'json'
 
         if options[:output]
           write_output(options[:output], data, format_type)
@@ -121,7 +121,7 @@ module Langfuse
         end
       end
 
-      def format_output(data, format_type: 'table')
+      def format_output(data, format_type: 'json')
         case format_type
         when 'json'
           JSON.pretty_generate(data)
@@ -129,9 +129,6 @@ module Langfuse
           # 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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lf-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Vicente Reig Rincon de Arellano
@@ -271,7 +271,6 @@ files:
 - 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

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

@@ -1,78 +0,0 @@
-require 'json'
-require 'date'
-require 'sorbet-runtime'
-
-module Langfuse
-  module CLI
-    module Formatters
-      class MarkdownFormatter
-        extend T::Sig
-
-        DEFAULT_MAX_CELL_BYTES = 2048
-
-        sig { params(data: T.untyped, max_cell_bytes: Integer).returns(String) }
-        def self.format(data, max_cell_bytes: DEFAULT_MAX_CELL_BYTES)
-          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], max_cell_bytes: max_cell_bytes)) }
-            output << "| #{values.join(' | ')} |"
-          end
-
-          output.join("\n")
-        end
-
-        private
-
-        sig { params(value: T.untyped, max_cell_bytes: Integer).returns(String) }
-        def self.format_value(value, max_cell_bytes:)
-          case value
-          when nil
-            ''
-          when Hash, Array
-            normalize(truncate(value.to_json, max_cell_bytes))
-          when Time, DateTime
-            normalize(truncate(value.iso8601, max_cell_bytes))
-          else
-            normalize(truncate(value.to_s, max_cell_bytes))
-          end
-        end
-
-        sig { params(str: String).returns(String) }
-        def self.escape_pipes(str)
-          # Escape pipe characters for markdown tables
-          str.gsub('|', '\\|')
-        end
-
-        sig { params(value: String, max_cell_bytes: Integer).returns(String) }
-        def self.truncate(value, max_cell_bytes)
-          return value if value.bytesize <= max_cell_bytes
-
-          visible = value.byteslice(0, max_cell_bytes)
-          "#{visible}...[truncated #{value.bytesize - max_cell_bytes} bytes]"
-        end
-
-        sig { params(value: String).returns(String) }
-        def self.normalize(value)
-          value.gsub(/\r\n?|\n/, '<br>')
-        end
-      end
-    end
-  end
-end