luciq-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b148325e3ea055acf54acad389f7d5617534b687bf06125fb2b5fd565150d23
+  data.tar.gz: 6faf85d4ff073213742b72294db3e95a0e22e802e559d3cfdd0e8957822e1849
+SHA512:
+  metadata.gz: 924ab969fefff13e013d4412414626b530dbcd81e46683dc471d70357e190122eec1eb730dfd6b12636dbd49573c1498d7b8ce5593e920bac9082635e945f9f8
+  data.tar.gz: 8ef521174571a0db1a2eefc181b39c291ace667f3dd21251a15cf193bb35aed06d4b310b93f28bcd1cdfced0a09407a157b0f9a46456722214ae21221eb4df34

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-12-16
+
+### Added
+
+- Initial release
+- `luciq login` - Authenticate with CLI token
+- `luciq logout` - Remove saved authentication
+- `luciq whoami` - Show current authenticated user
+- `luciq info` - Show CLI configuration
+- `luciq upload android-mapping` - Upload Android mapping files
+- `luciq version` - Show CLI version
+- Support for environment variables (`LUCIQ_AUTH_TOKEN`, `LUCIQ_URL`)
+- Support for config file (`~/.luciqrc`)

data/README.md

@@ -0,0 +1,125 @@
+# Luciq CLI
+
+Command-line interface for uploading symbol files to Luciq.
+
+## Installation
+
+### Using RubyGems
+
+```bash
+gem install luciq-cli
+```
+
+### Using Homebrew (macOS/Linux)
+
+```bash
+brew tap instabug/tap
+brew install luciq-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/Instabug/luciq-cli.git
+cd luciq-cli
+bundle install
+bundle exec rake install
+```
+
+## Quick Start
+
+### 1. Authenticate
+
+Generate a CLI token from your [Luciq Dashboard](https://dashboard.luciq.ai/company/cli), then:
+
+> **Self-hosted clusters:** Replace `dashboard.luciq.ai` with your cluster URL.
+
+```bash
+luciq login
+```
+
+Or pass the token directly:
+
+```bash
+luciq login --auth-token YOUR_CLI_TOKEN
+```
+
+### 2. Upload Symbol Files
+
+Upload Android mapping files (`.zip` containing a single mapping text file):
+
+```bash
+luciq upload android-mapping mapping.zip \
+  --app-token YOUR_APP_TOKEN \
+  --version-name 1.0.0 \
+  --version-code 1
+```
+
+| Option | Description |
+|--------|-------------|
+| `--app-token` | Luciq application token (required) |
+| `--version-name` | App version name, e.g., `1.0.0` (required) |
+| `--version-code` | App version code, e.g., `1` (required) |
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `luciq login` | Authenticate with Luciq |
+| `luciq logout` | Remove saved authentication |
+| `luciq whoami` | Show current authenticated user |
+| `luciq info` | Show CLI configuration |
+| `luciq upload android-mapping FILE` | Upload Android mapping file |
+| `luciq version` | Show CLI version |
+
+## Configuration
+
+Configuration is read from environment variables and `~/.luciqrc` file.
+
+### Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `LUCIQ_AUTH_TOKEN` | Authentication token |
+| `LUCIQ_URL` | API base URL (default: https://api.luciq.ai) |
+
+### Config File
+
+```
+# ~/.luciqrc
+token=your-cli-token
+url=https://api.luciq.ai
+```
+
+### Self-Hosted / Single Tenant
+
+If you're using a self-hosted or single tenant cluster, you need to configure the API URL:
+
+**Option 1: Environment variable**
+
+```bash
+export LUCIQ_URL=https://api.your-cluster.luciq.ai
+```
+
+**Option 2: Config file**
+
+Add the `url` to your `~/.luciqrc`:
+
+```
+token=your-cli-token
+url=https://api.your-cluster.luciq.ai
+```
+
+## Development
+
+```bash
+git clone https://github.com/Instabug/luciq-cli.git
+cd luciq-cli
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Test locally
+bundle exec bin/luciq --help
+```

data/bin/luciq

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'luciq/cli'
+
+Luciq::CLI.start(ARGV)

data/lib/luciq/api/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'net/http/post/multipart'
+require 'json'
+require 'uri'
+require 'luciq/config'
+
+module Luciq
+  module API
+    class Client
+      def initialize
+        @token = Config.load_token
+        @base_url = Config.load_base_url
+      end
+
+      def whoami
+        uri = build_uri('/api/web/public/cli/whoami')
+        request = Net::HTTP::Get.new(uri)
+        apply_headers(request)
+        execute(uri, request)
+      end
+
+      def upload_android_mapping(file_path:, app_token:, version_code:, version_name:)
+        uri = build_uri('/api/web/public/mappings')
+
+        File.open(file_path, 'rb') do |file|
+          params = {
+            'mapping_file' => UploadIO.new(file, 'application/octet-stream', File.basename(file_path)),
+            'application_token' => app_token,
+            'app_version_code' => version_code,
+            'app_version_name' => version_name
+          }
+
+          request = Net::HTTP::Post::Multipart.new(uri.path, params)
+          apply_headers(request)
+          execute(uri, request)
+        end
+      end
+
+      private
+
+      def build_uri(path)
+        URI("#{@base_url}#{path}")
+      end
+
+      def apply_headers(request)
+        request['User-Agent'] = "luciq-cli/#{Luciq::VERSION}"
+        request['Authorization'] = @token
+      end
+
+      def execute(uri, request)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.open_timeout = 30
+        http.read_timeout = 300
+
+        response = http.request(request)
+        return JSON.parse(response.body) if response.is_a?(Net::HTTPSuccess)
+
+        raise "Request failed (#{response.code}): #{response.body}"
+      end
+    end
+  end
+end

data/lib/luciq/cli.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'luciq/version'
+require 'luciq/commands/auth'
+require 'luciq/commands/upload'
+
+module Luciq
+  class UploadCLI < Thor
+    desc 'android-mapping FILE', 'Upload Android mapping file'
+    long_desc <<~DESC
+      Upload Android mapping files to Luciq for crash symbolication.
+      File format: .zip containing a single text file
+      Example:
+        luciq upload android-mapping mapping.zip --app-token APP_TOKEN --version-name 1.0.0 --version-code 1
+    DESC
+    option :app_token, type: :string, required: true, desc: 'Your Luciq application token'
+    option :version_name, type: :string, required: true, desc: 'App version name (e.g., 1.0.0)'
+    option :version_code, type: :string, required: true, desc: 'App version code (e.g., 1)'
+    def android_mapping(file)
+      Commands::Upload.new(options).android_mapping(file)
+    end
+  end
+
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'login', 'Authenticate with Luciq'
+    long_desc <<~DESC
+      Authenticate with Luciq using a CLI token.
+      Generate a CLI token from your Luciq dashboard: https://dashboard.luciq.ai/company/cli
+      The token will be saved in ~/.luciqrc
+    DESC
+    option :auth_token, type: :string, desc: 'CLI authentication token'
+    def login
+      Commands::Auth.new(options).login
+    end
+
+    desc 'logout', 'Remove saved authentication'
+    def logout
+      Commands::Auth.new(options).logout
+    end
+
+    desc 'whoami', 'Show current authenticated user'
+    def whoami
+      Commands::Auth.new(options).whoami
+    end
+
+    desc 'info', 'Show CLI configuration'
+    def info
+      Commands::Auth.new(options).info
+    end
+
+    desc 'upload SUBCOMMAND', 'Upload symbol files to Luciq'
+    subcommand 'upload', UploadCLI
+
+    desc 'version', 'Show CLI version'
+    def version
+      puts "luciq-cli #{Luciq::VERSION}"
+    end
+
+    map %w[--version] => :version
+  end
+end

data/lib/luciq/commands/auth.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'luciq/api/client'
+require 'luciq/config'
+
+module Luciq
+  module Commands
+    class Auth
+      def initialize(options = {})
+        @options = options
+      end
+
+      def login
+        token = @options[:auth_token]
+
+        unless token
+          puts 'Login to Luciq'
+          puts '=' * 40
+          puts 'Generate a CLI token from your Luciq dashboard: https://dashboard.luciq.ai/company/cli'
+          puts
+          puts "Note: For self-hosted clusters, replace 'dashboard' with your cluster name."
+          puts
+          print 'Paste your CLI token: '
+          token = $stdin.gets.chomp
+          puts
+        end
+
+        if token.empty?
+          puts '✗ No token provided.'
+          exit 1
+        end
+
+        Config.save_token(token)
+
+        puts '✓ Token saved to ~/.luciqrc'
+        puts "Run 'luciq info' to verify your configuration."
+      end
+
+      def whoami
+        client = API::Client.new
+
+        unless Config.load_token
+          puts '✗ Not authenticated. Run: luciq login'
+          exit 1
+        end
+
+        response = client.whoami
+
+        puts 'Authenticated as:'
+        puts "  Email: #{response['email']}"
+        puts "  Name:  #{response['name']}"
+      rescue StandardError => e
+        puts "✗ #{e.message}"
+        exit 1
+      end
+
+      def logout
+        Config.clear_token
+        puts '✓ Logged out.'
+      end
+
+      def info
+        puts "Luciq CLI version: #{Luciq::VERSION}"
+        puts '=' * 40
+        puts
+        puts 'Configuration:'
+        puts "  URL:                  #{Config.load_base_url}"
+        puts "  Authentication Token: #{Config.load_token || '(not set)'}"
+      end
+    end
+  end
+end

data/lib/luciq/commands/upload.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'luciq/api/client'
+
+module Luciq
+  module Commands
+    class Upload
+      def initialize(options = {})
+        @options = options
+        @client = API::Client.new
+      end
+
+      def android_mapping(file_path)
+        validate_file!(file_path)
+        validate_zip_extension!(file_path)
+
+        puts "Uploading Android mapping file: #{File.basename(file_path)}"
+        puts
+
+        @client.upload_android_mapping(
+          file_path: file_path,
+          app_token: @options[:app_token],
+          version_code: @options[:version_code],
+          version_name: @options[:version_name]
+        )
+
+        puts '✓ Android mapping file uploaded successfully!'
+      rescue StandardError => e
+        puts "✗ Upload failed: #{e.message}"
+        exit 1
+      end
+
+      private
+
+      def validate_file!(file_path)
+        unless File.exist?(file_path)
+          puts "✗ File not found: #{file_path}"
+          exit 1
+        end
+
+        return if File.readable?(file_path)
+
+        puts "✗ Cannot read file: #{file_path}"
+        exit 1
+      end
+
+      def validate_zip_extension!(file_path)
+        return if file_path.downcase.end_with?('.zip')
+
+        puts "✗ File must be a .zip archive: #{file_path}"
+        puts '  The ZIP should contain a single text file.'
+        exit 1
+      end
+    end
+  end
+end

data/lib/luciq/config.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Luciq
+  class Config
+    CONFIG_FILE = File.expand_path('~/.luciqrc')
+    DEFAULT_BASE_URL = 'https://api.luciq.ai'
+
+    class << self
+      def load_base_url
+        ENV['LUCIQ_URL'] || load_value('url') || DEFAULT_BASE_URL
+      end
+
+      def load_token
+        ENV['LUCIQ_AUTH_TOKEN'] || load_value('token')
+      end
+
+      def save_token(token)
+        add_value('token', token)
+      end
+
+      def clear_token
+        delete_value('token')
+      end
+
+      private
+
+      def load_value(key)
+        return nil unless File.exist?(CONFIG_FILE)
+
+        File.readlines(CONFIG_FILE).each do |line|
+          line = line.strip
+          next if line.empty? || line.start_with?('#')
+
+          if line.include?('=')
+            k, v = line.split('=', 2)
+            return v if k == key
+          end
+        end
+
+        nil
+      end
+
+      def add_value(key, value)
+        lines = File.exist?(CONFIG_FILE) ? File.readlines(CONFIG_FILE) : []
+        key_found = false
+        result = []
+
+        # Modify the existing value if it exists
+        lines.each do |line|
+          if line.strip.start_with?("#{key}=")
+            result << "#{key}=#{value}\n"
+            key_found = true
+          else
+            result << line
+          end
+        end
+
+        result << "#{key}=#{value}\n" unless key_found
+
+        File.write(CONFIG_FILE, result.join)
+      end
+
+      def delete_value(key)
+        return unless File.exist?(CONFIG_FILE)
+
+        lines = File.readlines(CONFIG_FILE)
+        result = lines.reject { |line| line.strip.start_with?("#{key}=") }
+
+        File.write(CONFIG_FILE, result.join)
+      end
+    end
+  end
+end

data/lib/luciq/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Luciq
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: luciq-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed Hany
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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'
+description: Interact with Luciq from the command line
+email:
+- ahany@luciq.ai
+executables:
+- luciq
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- bin/luciq
+- lib/luciq/api/client.rb
+- lib/luciq/cli.rb
+- lib/luciq/commands/auth.rb
+- lib/luciq/commands/upload.rb
+- lib/luciq/config.rb
+- lib/luciq/version.rb
+homepage: https://github.com/Instabug/luciq-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Instabug/luciq-cli
+  source_code_uri: https://github.com/Instabug/luciq-cli
+  changelog_uri: https://github.com/Instabug/luciq-cli/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message:
+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.5.11
+signing_key:
+specification_version: 4
+summary: Luciq CLI for developers
+test_files: []