strata-cli 0.1.0.beta

data/lib/strata/cli/credentials.rb

@@ -0,0 +1,83 @@
+require "yaml"
+require "tty-prompt"
+
+module Strata
+  module CLI
+    class Credentials
+      include Thor::Shell
+
+      # Retrieve existing credentials for the
+      # given ds_key or empty hash.
+      def self.fetch(ds_key)
+        CLI.config[ds_key] || {}
+      end
+
+      attr_reader :adapter, :credentials
+
+      def initialize(adapter)
+        @adapter = adapter.downcase.strip
+        @prompt = TTY::Prompt.new
+      end
+
+      def required?
+        adapter != "duckdb"
+      end
+
+      def collect
+        credentials = {}
+
+        case adapter
+        when "snowflake"
+          auth_mode = @prompt.select("Authentication mode:", %w[pat kp oauth], default: "pat")
+          credentials["auth_mode"] = auth_mode
+
+          case auth_mode
+          when "pat"
+            credentials["personal_access_token"] = @prompt.ask("Enter Personal Access Token:")
+          when "kp"
+            credentials["username"] = @prompt.ask("Enter Username:")
+            credentials["private_key"] = @prompt.ask("Enter Private Key Absolute Path:")
+          when "oauth"
+            credentials["oauth_client_id"] = @prompt.ask("OAuth Client ID:")
+            credentials["oauth_client_secret"] = @prompt.ask("OAuth Client Secret:")
+            credentials["oauth_redirect_uri"] = @prompt.ask("OAuth Redirect URI:", default: "https://localhost:3420/callback")
+            oauth_scope = @prompt.ask("OAuth Scope (optional):")
+            credentials["oauth_scope"] = oauth_scope unless oauth_scope.empty?
+          end
+        when "athena"
+          credentials["access_key_id"] = @prompt.ask("AWS Access Key ID:")
+          credentials["secret_access_key"] = @prompt.ask("AWS Secret Access Key:")
+        else
+          if required?
+            unless %w[postgres mysql trino sqlserver].include?(adapter)
+              credentials["username"] = @prompt.ask("Enter Username:")
+            end
+            credentials["password"] = @prompt.mask("Enter Password:")
+          end
+        end
+
+        @credentials = credentials
+      end
+
+      def collected?
+        !@credentials.keys.empty?
+      end
+
+      def write_local(ds_key, context)
+        context.gsub_file Configuration::STRATA_CONFIG_FILE, Utils.yaml_block_matcher(ds_key), ""
+        creds = "#{ds_key}:"
+        credentials.each do |key, val|
+          creds << "\n  #{key}: #{val}" unless val.nil? || val.empty?
+        end
+
+        context.append_to_file Configuration::STRATA_CONFIG_FILE, creds
+
+        # Set restrictive permissions (read/write for owner only)
+        strata_file = Configuration::STRATA_CONFIG_FILE
+        File.chmod(0o600, strata_file) if File.exist?(strata_file)
+      rescue Errno::EACCES => e
+        raise Strata::CommandError, "Permission denied setting permissions on #{strata_file}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/strata/cli/descriptions/create/migration.txt

@@ -0,0 +1,25 @@
+Create migration files for renaming or swapping entities in your Strata project.
+
+Migration subcommands:
+  rename    Create a migration to rename an entity (dimension, measure, table, datasource)
+  swap      Create a migration to swap entity references (dimension, measure, table)
+
+Options:
+  -e, --entity TYPE    Entity type: dimension, measure, table, or datasource (required)
+  -f, --from NAME     Current/source entity name (required)
+  -t, --to NAME       New/target entity name (required)
+
+Examples:
+  # Rename a dimension
+  strata create migration rename -e dimension -f old_name -t new_name
+
+  # Rename a table
+  strata create migration rename -e table -f old_table -t new_table
+
+  # Swap two measures
+  strata create migration swap -e measure -f measure_a -t measure_b
+
+  # Rename a datasource
+  strata create migration rename -e datasource -f old_ds -t new_ds
+
+Note: Swap operation does not support 'datasource' entity type.

data/lib/strata/cli/descriptions/create/relation.txt

@@ -0,0 +1,14 @@
+Create a relation YAML file for defining joins between tables.
+
+RELATION_PATH is the path where the relation file will be created.
+If RELATION_PATH contains a /, the file will be created at models/<RELATION_PATH>/rel.<last_part>.yml
+If RELATION_PATH has no /, the file will be created at models/rel.<RELATION_PATH>.yml
+The relation name is derived from the last part of the path.
+
+Examples:
+  strata create relation customer/orders    # Creates models/customer/rel.orders.yml
+  strata create relation customer           # Creates models/rel.customer.yml
+
+This will create a template relation file with examples and comments.
+You can then edit it to define your joins.
+

data/lib/strata/cli/descriptions/create/table.txt

@@ -0,0 +1,23 @@
+Create a semantic table model from a datasource table.
+
+TABLE_PATH can be:
+- Simple: call_center
+- Nested: games/event_details
+- With schema: contact/dse.call_center_d
+- Deep nested: contact/help_center/visits
+
+Examples:
+  strata create table call_center
+  strata create table games/event_details
+  strata create table contact/dse.call_center_d
+  strata create table contact/help_center/visits
+
+If no argument is provided, you'll be prompted to search and select a table.
+
+The command will:
+1. Check if the table exists in the datasource
+2. Fetch column metadata from the database
+3. Analyze columns with AI to suggest field definitions
+4. Allow you to review and edit fields interactively
+5. Generate the model YAML file at models/<TABLE_PATH>/tbl.<table_name>.yml
+

data/lib/strata/cli/descriptions/datasource/add.txt

@@ -0,0 +1,15 @@
+Add a new datasource interactively. This command will guide you through:
+
+1. Selecting a data warehouse adapter (PostgreSQL, MySQL, Snowflake, etc.)
+2. Configuring connection settings (host, port, database, etc.)
+3. Setting up authentication credentials
+4. Optionally configuring AI features for table generation
+
+ADAPTER is optional - if not provided, you'll be prompted to select one.
+
+Examples:
+  strata datasource add                  # Interactive mode - select adapter
+  strata datasource add postgres         # Directly add PostgreSQL datasource
+  strata datasource add snowflake        # Directly add Snowflake datasource
+
+Supported adapters: postgres, mysql, sqlserver, snowflake, athena, trino, duckdb, druid

data/lib/strata/cli/descriptions/datasource/auth.txt

@@ -0,0 +1,14 @@
+Example to set local credentials for a datasource with key games_dwh:
+
+  strata ds auth games_dwh
+
+Example to set remote credentials for the same datasource:
+
+  strata ds auth games_dwh -r
+
+Local credentials are saved in the projects .strata file. This will should not
+be checked into git.
+
+Remote credentials will securely send the credentials to the Strata server. This is
+not requires for some modes like OAuth. In that case each user will be prompted to 
+go through the OAuth flow. Not all adapters support OAuth.

data/lib/strata/cli/descriptions/datasource/exec.txt

@@ -0,0 +1,7 @@
+Example: run a single query inline on csops_db 
+
+  strata ds exec csops_db -q "select * from customer limit 10;"
+
+Example: run queries from a file 
+
+  strata ds exec csops_db -f path/to/my/file.sql

data/lib/strata/cli/descriptions/datasource/meta.txt

@@ -0,0 +1,11 @@
+Show the schema/structure of a specific table in the datasource.
+Displays column names, data types, and other metadata.
+
+Options:
+  -c, --catalog CATALOG    Override catalog from datasource config
+  -s, --schema SCHEMA      Override schema from datasource config
+
+Examples:
+  strata datasource meta my_db customers           # Show customers table structure
+  strata datasource meta my_db dbo.orders          # Show orders table in dbo schema
+  strata datasource meta my_db sales.customers -s sales  # Explicitly specify schema

data/lib/strata/cli/descriptions/datasource/tables.txt

@@ -0,0 +1,12 @@
+List all tables available in the specified datasource. If DS_KEY is not provided,
+you'll be prompted to select from available datasources.
+
+Options:
+  -p, --pattern PATTERN    Filter tables by regex pattern
+  -c, --catalog CATALOG    Override catalog from datasource config
+  -s, --schema SCHEMA      Override schema from datasource config
+
+Examples:
+  strata datasource tables my_db         # List all tables
+  strata datasource tables my_db -p user # List tables matching "user"
+  strata datasource tables my_db -s dbo  # List tables in "dbo" schema

data/lib/strata/cli/descriptions/datasource/test.txt

@@ -0,0 +1,8 @@
+Test the connection to a datasource. This verifies that:
+- The datasource configuration is valid
+- Credentials are correct
+- The connection can be established
+
+Examples:
+  strata datasource test my_db           # Test connection to my_db datasource
+  strata ds test postgres_db             # Using alias

data/lib/strata/cli/descriptions/deploy/deploy.txt

@@ -0,0 +1,24 @@
+Deploys your Strata project to the configured server. This command will:
+
+1. Run pre-deployment audit checks (unless --skip-audit is used)
+2. Check git repository status and ensure all changes are committed
+3. Create an archive of changed files since the last deployment
+4. Upload the archive to the Strata server
+5. Monitor deployment progress and display results
+
+The deployment includes all YAML files in your project (models, datasources, tests).
+Only files that have changed since the last successful deployment are included,
+unless --force is used to deploy all files.
+
+Options:
+  -e, --environment ENV    Deploy to specific environment (dev, staging, prod)
+  --skip-audit            Skip pre-deployment audit checks
+  --yes, -y               Skip confirmation prompts (useful for CI/CD)
+  -f, --force             Force deploy even if no files have changed
+
+Examples:
+  strata deploy                          # Deploy to default environment
+  strata deploy -e production            # Deploy to production environment
+  strata deploy --skip-audit             # Skip pre-deployment checks
+  strata deploy --force                  # Force deploy even if no changes
+  strata deploy --yes                    # Skip confirmation prompts

data/lib/strata/cli/descriptions/deploy/status.txt

@@ -0,0 +1,9 @@
+Displays the current deployment status for the active git branch.
+Shows deployment stage, status (succeeded/failed/in_progress), and test results if available.
+
+Options:
+  -e, --environment ENV    Check status for specific environment
+
+Examples:
+  strata deploy status                   # Show status for current branch
+  strata deploy status -e production     # Show status for production environment

data/lib/strata/cli/descriptions/init.txt

@@ -0,0 +1,14 @@
+Initialize a new Strata project or clone from an existing repository.
+
+PROJECT_NAME is optional when using --source option. If provided, creates a new project
+with that name. If using --source, clones the existing project from the URL.
+
+Options:
+  -d, --datasource ADAPTER    Add one or more datasource adapters (repeatable)
+  -s, --source URL            URL of existing project to clone
+  -a, --api-key KEY           API key (required when using --source)
+
+Examples:
+  strata init my-project
+  strata init my-project -d postgres -d snowflake
+  strata init --source https://github.com/org/project.git --api-key YOUR_KEY

data/lib/strata/cli/generators/datasource.rb

@@ -0,0 +1,83 @@
+require_relative "group"
+require "open3"
+
+module Strata
+  module CLI
+    module Generators
+      class Datasource < Group
+        argument :adapter, type: :string, desc: "Data warehouse adapter to add as a datasource.", required: true
+        argument :name, type: :string, desc: "Optional name to be used as the key for the datasource.", required: false
+        class_option :path, type: :string, desc: "Need path when outside project directory"
+
+        def check_duckdb_requirements
+          return unless adapter.downcase == "duckdb"
+
+          unless duckdb_installed?
+            raise DWH::ConfigError,
+              "DuckDB is not installed. Please install DuckDB. We will need the header files to compile libraries."
+          end
+
+          install_duckdb_gem
+        end
+
+        def add_datasource_config
+          @ds_key = get_unique_ds_key
+          say_status :adapter, "adding #{adapter} config to datasources", :yellow
+
+          # Interactive mode: write config directly from prompts
+          config_yaml = {@ds_key => options[:config]}.to_yaml.sub(/^---\n/, "\n")
+          append_to_file pathify("datasources.yml"), config_yaml
+        end
+
+        private
+
+        def duckdb_installed?
+          # Check if DuckDB is installed globally by trying to run it
+          # Use Open3 for cross-platform compatibility (Windows doesn't support shell redirection)
+          _, _, status = Open3.capture3("duckdb", "--version")
+          status.success?
+        rescue Errno::ENOENT
+          # duckdb command not found
+          false
+        end
+
+        def install_duckdb_gem
+          say_status :gem, "Installing duckdb gem...", :yellow
+
+          begin
+            # Install the duckdb gem
+            run "gem install duckdb", verbose: false, capture: true
+            say_status :success, "duckdb gem installed successfully", :green
+          rescue => e
+            raise DWH::ConfigError, "Failed to install duckdb gem: #{e.message}"
+          end
+        end
+
+        def pathify(file)
+          options["path"].nil? ? file : "#{options["path"].gsub(%r{$/}, "")}/#{file}"
+        end
+
+        def get_unique_ds_key
+          base_key = (name && !name.strip.empty?) ? Utils.url_safe_str(name) : adapter
+          key_id = 1
+          ds_key = base_key
+          while current_ds.key?(ds_key)
+            ds_key = "#{base_key}_#{key_id}"
+            key_id += 1
+          end
+          ds_key
+        end
+
+        def current_ds
+          @ds ||= YAML.safe_load_file(pathify("datasources.yml"), permitted_classes: [Date, Time], aliases: true) || {}
+        end
+
+        def render_template(source, context: instance_eval("binding", __FILE__, __LINE__))
+          source = File.expand_path(find_in_source_paths(source.to_s))
+          capturable_erb = CapturableERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer")
+          capturable_erb.tap { |erb| erb.filename = source }.result(context)
+        end
+      end
+    end
+  end
+end

data/lib/strata/cli/generators/group.rb

@@ -0,0 +1,13 @@
+module Strata::CLI::Generators
+  class Group < Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path("templates/", __dir__)
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/strata/cli/generators/migration.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "group"
+
+module Strata
+  module CLI
+    module Generators
+      # Generates migration YAML files from templates.
+      class Migration < Group
+        argument :operation, type: :string, desc: "Migration operation: rename or swap"
+        argument :entity, type: :string, desc: "Entity type"
+        argument :from, type: :string, desc: "Source/current entity name"
+        argument :to, type: :string, desc: "Target/new entity name"
+
+        def create_migration_file
+          timestamp = generate_timestamp
+          filename = generate_filename(operation, entity, from, to, timestamp)
+          output_path = File.join("migrations", filename)
+
+          # Ensure directory exists
+          empty_directory "migrations"
+
+          # Load template and update with user inputs
+          template_content = load_template(operation)
+          hook = options[:hook] || ((operation == "swap") ? "post" : "pre")
+          updated_content = update_template(template_content, hook)
+
+          # Write the updated template
+          create_file output_path, updated_content
+
+          say_status :created, output_path, :green
+        end
+
+        private
+
+        def load_template(operation)
+          template_name = "migration.#{operation}.yml"
+          template_path = File.join(File.dirname(__FILE__), "templates", template_name)
+          File.read(template_path)
+        end
+
+        def update_template(template_content, hook)
+          template_content.gsub("<entity_type>", entity)
+            .gsub("<from_name>", from)
+            .gsub("<to_name>", to)
+            .gsub("<hook>", hook)
+        end
+
+        def generate_timestamp
+          Time.now.strftime("%Y%m%d%H%M%S")
+        end
+
+        def generate_filename(operation, entity, from, to, timestamp)
+          # Generate descriptive name following server pattern: timestamp_descriptive_name.yml
+          # Example: 20250101120000_rename_user_table.yml
+          from_slug = slugify(from)
+          to_slug = slugify(to)
+          descriptive_name = "#{operation}_#{from_slug}_to_#{to_slug}"
+          "#{timestamp}_#{descriptive_name}.yml"
+        end
+
+        def slugify(text)
+          text.to_s.downcase
+            .gsub(/[^a-z0-9]+/, "_")
+            .gsub(/^_|_$/, "")
+            .slice(0, 50) # Limit length
+        end
+      end
+    end
+  end
+end

data/lib/strata/cli/generators/project.rb

@@ -0,0 +1,190 @@
+require_relative "group"
+require_relative "datasource"
+require_relative "../helpers/project_helper"
+require_relative "../api/connection_error_handler"
+require "faraday"
+require "json"
+require "uri"
+
+module Strata::CLI
+  module Generators
+    class Project < Group
+      include API::ConnectionErrorHandler
+
+      BASE_SERVER_URL = "http://localhost:3000"
+
+      argument :name, type: :string, required: false, desc: "The name of the project. Optional when using --source."
+      class_option :datasource, type: :string, repeatable: true
+      class_option :source, type: :string
+      class_option :api_key, type: :string
+
+      desc "Generates a new Strata project."
+
+      def validate_options
+        if options.key?(:source)
+          raise Strata::CommandError, "API key is required when using --source option. Use --api-key option." unless options.key?(:api_key)
+        else
+          raise Strata::CommandError, "PROJECT_NAME is required when not using --source option." unless @name && !@name.to_s.strip.empty?
+        end
+      end
+
+      def fetch_and_clone_if_available
+        return unless options.key?(:source)
+
+        project_info = fetch_project_info
+        @project_id = project_info["id"]
+        @project_info = project_info
+
+        return unless project_info["git_url"] && !project_info["git_url"].empty?
+
+        @cloned_from_git = true
+        clone_project(project_info["git_url"])
+      end
+
+      def create_project_structure
+        return if cloned_from_git?
+
+        empty_directory uid
+        empty_directory File.join(uid, "models")
+        empty_directory File.join(uid, "tests")
+      end
+
+      def create_strata_config_file
+        template "strata.yml", "#{uid}/.strata"
+      end
+
+      def create_project_file
+        return if cloned_from_git?
+
+        template "project.yml", "#{uid}/project.yml"
+      end
+
+      def persist_project_id_if_needed
+        # Persist project_id after project.yml exists (either from clone or creation)
+        return unless @project_id
+
+        project_yml_path = File.join(uid, "project.yml")
+        return unless File.exist?(project_yml_path)
+
+        persist_project_id_to_project_yml
+      end
+
+      def create_datasources_file
+        return if cloned_from_git?
+
+        template "datasources.yml", "#{uid}/datasources.yml"
+
+        return unless options.key?(:datasource)
+
+        options[:datasource].each do |ds|
+          raise DWH::ConfigError, "Unsupported datasource #{ds}" unless DWH.adapter?(ds.to_sym)
+
+          Datasource.new([ds.downcase.strip], options.merge({"path" => uid})).invoke_all
+        end
+      end
+
+      def initialize_git
+        return if cloned_from_git?
+
+        inside uid do
+          run "git init", verbose: false, capture: true
+          create_file ".gitignore", ".strata\n"
+        end
+      end
+
+      def setup_datasource
+        return if cloned_from_git?
+        return if options.key?(:datasource) # Already specified via CLI option
+
+        say "\n", :white
+        say_status :setup, "Let's configure your first datasource", :cyan
+
+        # Change into the project directory and run the existing add command
+        inside(uid) do
+          require_relative "../sub_commands/datasource"
+          SubCommands::Datasource.new.add
+        end
+      end
+
+      def completion_message
+        say "\n✔ Strata project '#{uid}' is ready!", :green
+        say "\nNext steps:", :yellow
+        say "  1. cd #{uid}", :cyan
+        say "  2. strata datasource add      # To add more datasources", :cyan
+        say "  3. strata create table      # Start adding tables", :cyan
+        say "\n"
+      end
+
+      private
+
+      def cloned_from_git?
+        @cloned_from_git ||= false
+      end
+
+      def fetch_project_info
+        conn = Faraday.new(url: options[:source]) do |f|
+          f.request :authorization, "Bearer", options[:api_key]
+          f.response :json
+        end
+
+        response = with_connection_error_handling(options[:source]) do
+          conn.get
+        end
+
+        unless response.success?
+          raise Strata::CommandError,
+            "Failed to fetch project info from #{options[:source]}. Status: #{response.status}"
+        end
+
+        response.body
+      end
+
+      def clone_project(git_url)
+        say_status :clone, "Cloning project from #{git_url}", :green
+        run "git clone #{git_url} #{uid}", verbose: false, capture: true
+
+        raise Strata::CommandError, "Failed to clone repository from #{git_url}" unless File.directory?(uid)
+
+        say_status :success, "Project cloned successfully", :green
+      end
+
+      def persist_project_id_to_project_yml
+        return unless @project_id
+
+        project_yml_path = File.join(uid, "project.yml")
+        Helpers::ProjectHelper.persist_project_id_to_yml(@project_id, project_yml_path: project_yml_path)
+      end
+
+      def uid
+        @uid ||= if options.key?(:source) && @project_info
+          @project_info["uid"] || options[:source].split("/").last
+        else
+          Utils.url_safe_str(name)
+        end
+      end
+
+      def name
+        # Use name from server if available (when using --source), otherwise use argument
+        return @project_info["name"] if options.key?(:source) && @project_info
+        @name
+      end
+
+      def server_url
+        return options[:source] if options.key?(:source)
+        BASE_SERVER_URL
+      end
+
+      def description
+        return @project_info["description"] if options.key?(:source) && @project_info
+        nil
+      end
+
+      def production_branch
+        return @project_info["production_branch"] if options.key?(:source) && @project_info && @project_info["production_branch"]
+        "main"
+      end
+
+      attr_reader :project_id
+    end
+  end
+end