strata-cli 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d417b55f20b06dadf03dd915ec77c78ac145a95ee820d3728ef31ba399aadf57
+  data.tar.gz: 929ee748ca1082a29ac9de3a348768e93aaa4ec494a9d6033fba2de3f4d12966
+SHA512:
+  metadata.gz: d821fe082a53140b3ae66bd7d612198dbba107d5c7bfccb3bee530fb30e831f3be8c86066062463a1ee79347910d6d3e006dc8f8bf4988c5860de9272e0016dc
+  data.tar.gz: 298ec8199c214af514816a2f8dc00068a9f5f073c3cf395cf3904b213875d55719eb558c24a79f22f3fc2c4e8fe790ea98c811ac8155c061262f5a60645dcea0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.4.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-22
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,65 @@
+# Project Context
+
+## Project Overview
+
+This project is a Ruby CLI app built with the Thor gem.  Its primary purpose is to provide to manage the Semantic Layer hosted in a Strata Server app.  It will used by Data Engineers to configure datasource connection and define the the semantic model.
+
+## Tech Stack
+
+- **Language**: [Ruby]
+- **Framework**: Strata Server is a Ruby on Rails app
+- **Key Libraries**: [dwh]
+
+## Project Structure
+
+```
+/lib          # Source code
+/tests        # Test files
+/docs         # Documentation
+```
+
+## Development Guidelines
+
+### Code Style
+
+- Follow [standardrb style]
+- Be succinct and optimize for readability
+- Reuse existing code as much as possible
+- Do not unnecessarily split a method into multiple methods
+  - Split the method when the new method will be used in more than one place
+  - Split the method if the method gets to long to maintain readability.
+- Use meaningful variable names
+- Comment complex logic
+
+### Testing
+
+- Write tests for new features
+- Maintain test coverage above [X]%
+- Run tests before commits
+
+### Git Workflow
+
+- Use conventional commits
+- Create feature branches from main
+- Squash commits before merging
+
+## Key Files & Directories
+
+- `[.strata]` - [This CLI will create a .strata file based strata.yml that will contain secrets necessary to access various endpoints.  It will also have config that lets the project connect to the right Strata server.]
+- `[cli.rb]` - [main application file]
+
+## Common Tasks
+
+## Architecture Notes
+
+- [Support ruby >= 3.4.4. Cli can be installed as a gem or via shell script.]
+- [Follow the style of Ruby on Rails CLI where possible]
+
+## Current Priorities
+
+## Debugging & Troubleshooting
+
+- **Common issue**: Database endpoints are not reachable. This is because we either need to run the requisite docker image or setup a cloud connection to aws snowflake, google etc.
+- **Environment setup**: docker compose as needed
+
+## External Resources

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Strata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,465 @@
+# Strata CLI
+
+Command-line interface for the Strata Semantic Analytics System. Create, manage, and deploy Strata projects with ease.
+
+## Installation
+
+```bash
+gem install strata-cli
+```
+
+Or add to your Gemfile:
+
+```bash
+bundle add strata-cli
+```
+
+## Requirements
+
+- Ruby >= 3.4.4
+- Git (for deployment features)
+- Access to a Strata server
+
+## Quick Start
+
+```bash
+# Initialize a new project
+strata init my-project
+
+# Add a datasource
+strata datasource add
+
+# Create a semantic table model
+strata create table customers
+
+# Deploy to server
+strata deploy
+```
+
+## Commands Overview
+
+> 💡 **Tip:** Run `strata COMMAND --help` for detailed help, options, and examples on any command. The CLI help system provides comprehensive documentation for each command.
+
+<details>
+<summary><strong>Project Management</strong></summary>
+
+### `strata init [PROJECT_NAME]`
+
+Initialize a new Strata project or clone from an existing repository.
+
+**Options:**
+- `-d, --datasource ADAPTER` - Add datasource adapters (repeatable)
+- `-s, --source URL` - Clone existing project from URL
+- `-a, --api-key KEY` - API key (required with `--source`)
+
+**Examples:**
+```bash
+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
+```
+
+### `strata project link PROJECT_ID`
+
+Link local project to an existing project on the Strata server.
+
+**Examples:**
+```bash
+strata project link 12345
+```
+
+</details>
+
+<details>
+<summary><strong>Datasource Management</strong> (alias: `ds`)</summary>
+
+### `strata datasource adapters`
+List all supported data warehouse adapters.
+
+### `strata datasource list`
+List all configured datasources with their keys and display names.
+
+### `strata datasource add [ADAPTER]`
+Add a new datasource interactively. `ADAPTER` is optional - prompts if omitted.
+
+**Examples:**
+```bash
+strata datasource add              # Interactive mode
+strata datasource add postgres     # Direct selection
+strata ds add snowflake            # Using alias
+```
+
+### `strata datasource auth DS_KEY`
+Set credentials for a datasource. Credentials stored in `.strata` file.
+
+**Options:** `-r, --remote` - Set credentials on remote server
+
+**Examples:**
+```bash
+strata datasource auth my_db
+strata ds auth postgres_db --remote
+```
+
+### `strata datasource test DS_KEY`
+Test connection to a datasource.
+
+**Examples:**
+```bash
+strata datasource test my_db
+```
+
+### `strata datasource tables [DS_KEY]`
+List all tables in a datasource with interactive filtering.
+
+**Options:** `-p, --pattern PATTERN`, `-c, --catalog CATALOG`, `-s, --schema SCHEMA`
+
+**Examples:**
+```bash
+strata datasource tables my_db
+strata datasource tables my_db -p user -s dbo
+```
+
+### `strata datasource meta DS_KEY TABLE_NAME`
+Show the schema/structure of a specific table.
+
+**Options:** `-c, --catalog CATALOG`, `-s, --schema SCHEMA`
+
+**Examples:**
+```bash
+strata datasource meta my_db customers
+strata datasource meta my_db dbo.orders
+```
+
+### `strata datasource exec DS_KEY`
+Execute SQL queries on a datasource.
+
+**Options:** `-q, --query QUERY`, `-f, --file PATH`
+
+**Examples:**
+```bash
+strata datasource exec my_db -q "SELECT * FROM customers LIMIT 10"
+strata datasource exec my_db -f queries/analysis.sql
+```
+
+</details>
+
+<details>
+<summary><strong>Model Creation</strong></summary>
+
+### `strata create table [TABLE_PATH]`
+Create a semantic table model from a datasource table.
+
+**Options:** `-d, --datasource DS_KEY`
+
+**Examples:**
+```bash
+strata create table                        # Interactive mode
+strata create table call_center             # Simple path
+strata create table games/event_details     # Nested path
+strata create table contact/dse.call_center_d  # With schema
+```
+
+**Process:** Checks table existence → Fetches metadata → AI suggests fields → Interactive editor → Generates model file
+
+### `strata create relation RELATION_PATH`
+Create a relation (join) definition file.
+
+**Options:** `-d, --datasource DS_KEY`
+
+**Examples:**
+```bash
+strata create relation customer/orders    # Creates models/customer/rel.orders.yml
+strata create relation customer           # Creates models/rel.customer.yml
+```
+
+### `strata create migration rename`
+Create a migration file to rename an entity.
+
+**Options:** `-e, --entity TYPE` (required), `-f, --from NAME` (required), `-t, --to NAME` (required)
+
+**Entity types:** `dimension`, `measure`, `table`, `datasource`
+
+**Examples:**
+```bash
+strata create migration rename -e dimension -f old_name -t new_name
+strata create migration rename -e table -f old_table -t new_table
+```
+
+### `strata create migration swap`
+Create a migration file to swap entity references.
+
+**Options:** `-e, --entity TYPE` (required), `-f, --from NAME` (required), `-t, --to NAME` (required)
+
+**Entity types:** `dimension`, `measure`, `table` (datasource not supported)
+
+**Examples:**
+```bash
+strata create migration swap -e measure -f measure_a -t measure_b
+```
+
+</details>
+
+<details>
+<summary><strong>Table Management</strong> (aliases: `t`, `tbl`)</summary>
+
+### `strata table list`
+List all semantic table models in the project.
+
+**Examples:**
+```bash
+strata table list
+strata t list
+```
+
+</details>
+
+<details>
+<summary><strong>Deployment</strong></summary>
+
+### `strata deploy`
+Deploy project to Strata server for the current branch.
+
+**Options:**
+- `-e, --environment ENV` - Deploy to specific environment
+- `--skip-audit` - Skip pre-deployment audit checks
+- `--yes, -y` - Skip confirmation prompts (CI/CD mode)
+- `-f, --force` - Force deploy even if no files changed
+
+**Examples:**
+```bash
+strata deploy
+strata deploy -e production
+strata deploy --skip-audit --yes    # CI/CD mode
+strata deploy --force
+```
+
+**Process:** Audit checks → Git status → Create archive → Upload → Monitor progress
+
+### `strata deploy status`
+Show current deployment status for the active branch.
+
+**Options:** `-e, --environment ENV`
+
+**Examples:**
+```bash
+strata deploy status
+strata deploy status -e production
+```
+
+</details>
+
+<details>
+<summary><strong>Audit & Validation</strong> (alias: `a`)</summary>
+
+### `strata audit` or `strata audit all`
+Run all audit checks (syntax, models, connections). This is the default command.
+
+### `strata audit syntax`
+Check YAML syntax of all configuration files.
+
+### `strata audit models`
+Validate model definitions and schema structure.
+
+### `strata audit connections`
+Test all datasource connections.
+
+**Examples:**
+```bash
+strata audit              # Run all checks
+strata audit syntax       # Check YAML syntax only
+strata a models           # Validate models only
+```
+
+</details>
+
+<details>
+<summary><strong>Utilities</strong></summary>
+
+### `strata version`
+Print the CLI version.
+
+### `strata adapters`
+List all supported data warehouse adapters.
+
+</details>
+
+## Configuration
+
+### Project Configuration (`project.yml`)
+
+Main project configuration file:
+
+```yaml
+name: My Project
+uid: my-project
+description: Description of my project
+server: https://strata.example.com
+production_branch: main
+git: https://github.com/org/project.git
+project_id: 123  # Auto-populated after first deployment
+```
+
+**Multi-Environment Configuration:**
+
+```yaml
+# Default environment
+server: http://localhost:3000
+
+# Environment-specific configs
+dev:
+  server: http://localhost:3000
+  api_key: dev-key
+
+production:
+  server: https://app.strata.com
+  api_key: prod-key
+```
+
+### Local Configuration (`.strata`)
+
+Stores sensitive credentials. **Never committed to git** (automatically excluded).
+
+```yaml
+api_key: your-api-key-here
+
+# Datasource credentials
+my_db:
+  username: user
+  password: pass
+
+# AI configuration (optional)
+ai_provider: openai
+ai_api_key: your-ai-key
+```
+
+**Security:** The `.strata` file automatically has restrictive permissions (0600) for security.
+
+### Datasources Configuration (`datasources.yml`)
+
+Defines all datasource connections:
+
+```yaml
+my_postgres:
+  adapter: postgres
+  name: PostgreSQL Database
+  host: localhost
+  port: 5432
+  database: mydb
+  schema: public
+  ssl: false
+  tier: warm
+  query_timeout: 3600
+
+my_snowflake:
+  adapter: snowflake
+  name: Snowflake Warehouse
+  account_identifier: myorg-myaccount
+  database: ANALYTICS_DB
+  warehouse: COMPUTE_WH
+  schema: PUBLIC
+  role: ACCOUNTADMIN
+  auth_mode: pat
+```
+
+## Supported Data Warehouse Adapters
+
+- **PostgreSQL** - Full support
+- **MySQL** - Full support
+- **SQL Server** - Full support (including Azure)
+- **Snowflake** - Full support (PAT, Key Pair, OAuth)
+- **Athena** - AWS Athena support
+- **Trino** - Trino/Presto support
+- **DuckDB** - Embedded analytics database
+- **Druid** - Apache Druid support
+
+## Security
+
+- ✅ Credentials stored in `.strata` with restrictive permissions (0600)
+- ✅ API keys never accepted via command line arguments
+- ✅ File paths validated to prevent path traversal attacks
+- ✅ Git commit hashes validated before use
+- ✅ YAML files loaded safely to prevent code execution
+
+## Troubleshooting
+
+<details>
+<summary><strong>Common Issues</strong></summary>
+
+### "Permission denied" errors
+
+Ensure you have write permissions in the project directory. The `.strata` file permissions are automatically set to 0600.
+
+### "Server URL not configured"
+
+Add the `server` field to your `project.yml`:
+
+```yaml
+server: https://your-strata-server.com
+```
+
+### "API key not found"
+
+Run `strata deploy` and enter your API key when prompted, or manually add to `.strata`:
+
+```yaml
+api_key: your-api-key
+```
+
+### "Uncommitted changes" during deploy
+
+Commit or stash your changes:
+
+```bash
+git add .
+git commit -m "Your changes"
+strata deploy
+```
+
+### "Table not found" when creating model
+
+- Verify the table exists in the datasource
+- Check schema/catalog settings
+- Use `strata datasource tables DS_KEY` to list available tables
+- Use `strata datasource meta DS_KEY TABLE_NAME` to verify table structure
+
+### Connection test failures
+
+- Verify credentials with `strata datasource auth DS_KEY`
+- Check network connectivity
+- Verify datasource configuration in `datasources.yml`
+- Test connection with `strata datasource test DS_KEY`
+
+</details>
+
+## Development
+
+After checking out the repo:
+
+```bash
+bin/setup
+```
+
+Run tests:
+
+```bash
+rake test
+```
+
+Install locally:
+
+```bash
+bundle exec rake install
+```
+
+Release a new version:
+
+1. Update version in `lib/strata/cli/version.rb`
+2. Run `bundle exec rake release`
+
+## Contributing
+
+Bug reports and pull requests welcome on GitHub at https://github.com/stratasite/strata-cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/strata

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/strata/cli"
+
+Strata::CLI.start(ARGV)

data/lib/strata/cli/ai/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "ruby_llm"
+require_relative "configuration"
+
+module Strata
+  module CLI
+    module AI
+      # Custom error class for AI-related errors
+      class AIError < StandardError; end
+
+      # Client wraps ruby_llm gem for unified LLM access.
+      class Client
+        attr_reader :config, :chat
+
+        def initialize(config = Configuration.new)
+          @config = config
+          configure_ruby_llm if enabled?
+        end
+
+        # Check if AI is enabled and configured
+        def enabled?
+          @config.enabled?
+        end
+
+        # Complete a prompt using the configured provider
+        # @param prompt [String] The user prompt
+        # @param system_prompt [String, nil] Optional system context
+        # @return [String] The AI response
+        def complete(prompt, system_prompt: nil)
+          raise AIError, "AI is not enabled. Configure ai_api_key in .strata" unless enabled?
+
+          chat = RubyLLM.chat(model: @config.model_or_default)
+          chat.with_instructions(system_prompt) if system_prompt
+          response = chat.ask(prompt)
+          response.content
+        rescue RubyLLM::Error => e
+          raise AIError, "LLM error: #{e.message}"
+        end
+
+        private
+
+        def configure_ruby_llm
+          RubyLLM.configure do |c|
+            # Dynamically set the API key for the configured provider
+            # e.g. c.gemini_api_key = ... or c.openai_api_key = ...
+            provider_key_method = "#{@config.provider}_api_key="
+
+            if c.respond_to?(provider_key_method)
+              c.public_send(provider_key_method, @config.api_key)
+            else
+              # Fallback or error if the provider setter doesn't exist on the config object
+              # This might happen if 'provider' string doesn't match the config accessor
+              # but RubyLLM conventions usually align.
+              raise AIError,
+                "Could not configure RubyLLM for provider '#{@config.provider}'. Check if helper method '#{provider_key_method}' exists."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strata/cli/ai/configuration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Strata
+  module CLI
+    module AI
+      class Configuration
+        require "ruby_llm"
+        PROVIDERS = RubyLLM::Providers.constants.map { |c| c.to_s.downcase }.sort.freeze
+
+        attr_reader :provider, :api_key, :model
+
+        def initialize
+          @provider = CLI.config["ai_provider"] || default_provider
+          @api_key = CLI.config["ai_api_key"]
+          @model = CLI.config["ai_model"]
+        end
+
+        def enabled?
+          CLI.config["ai_enabled"] != false && !@api_key.nil? && !@api_key.empty?
+        end
+
+        def default_provider
+          "gemini"
+        end
+
+        def default_model
+          case @provider
+          when "gemini" then "gemini-2.0-flash"
+          when "openai" then "gpt-4o-mini"
+          when "anthropic" then "claude-sonnet-4-20250514"
+          when "mistral" then "mistral-large-latest"
+          when "deepseek" then "deepseek-chat"
+          else
+            # For other providers, we don't have a specific default.
+            # The user should specify a model in .strata or via CLI if needed.
+            # Returning nil here might cause issues if a default is expected,
+            # so we'll return a safe fallback or let the provider helper handle it.
+            nil
+          end
+        end
+
+        def model_or_default
+          @model || default_model
+        end
+      end
+    end
+  end
+end