Feature/improve doc and cli (#24)

* feat: Add option to disable reload in web server and update navigation accordingly
* feat: Enhance CLI with production mode and logging options; update web application configuration
* feat: Update README with production mode and logging options for CLI

Author: ionos-landgraf-vin

README.md

@@ -44,6 +44,9 @@ Access at: <http://localhost:4567>
 # Run web server (default)
 docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight
 
+# Run in production mode with logging
+docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight web --production
+
 # Run lint
 docker run -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight lint -r /resources
 
@@ -62,13 +65,31 @@ Access web interface at: <http://localhost:4567>
 ## CLI Commands
 
 ```bash
-archsight web [--resources PATH] [--port PORT]  # Start web server
-archsight lint [--resources PATH]               # Validate YAML and relations
-archsight template KIND                         # Generate YAML template for a resource type
-archsight console [--resources PATH]            # Interactive Ruby console
-archsight version                               # Show version
+archsight web [OPTIONS]      # Start web server
+archsight lint               # Validate YAML and relations
+archsight import             # Execute pending imports
+archsight analyze            # Execute analysis scripts
+archsight template KIND      # Generate YAML template for a resource type
+archsight console            # Interactive Ruby console
+archsight version            # Show version
+```
+
+### Web Server Options
+
+```bash
+archsight web [--resources PATH] [--port PORT] [--host HOST]
+              [--production] [--disable-reload] [--enable-logging]
 ```
 
+| Option | Description |
+|--------|-------------|
+| `-r, --resources PATH` | Path to resources directory |
+| `-p, --port PORT` | Port to listen on (default: 4567) |
+| `-H, --host HOST` | Host to bind to (default: localhost) |
+| `--production` | Run in production mode (quiet startup) |
+| `--disable-reload` | Disable the reload button in the UI |
+| `--enable-logging` | Enable request logging (default: false in dev, true in prod) |
+
 ## Features
 
 ### MCP Server

lib/archsight/cli.rb

@@ -16,9 +16,16 @@ def self.exit_on_failure?
     desc "web", "Start the web server"
     option :port, aliases: "-p", type: :numeric, default: 4567, desc: "Port to listen on"
     option :host, aliases: "-H", type: :string, default: "localhost", desc: "Host to bind to"
+    option :production, type: :boolean, default: false, desc: "Run in production mode"
+    option :disable_reload, type: :boolean, default: false, desc: "Disable the reload button in the UI"
+    option :enable_logging, type: :boolean, default: nil, desc: "Enable request logging (default: false in dev, true in prod)"
     def web
       configure_resources
       require "archsight/web/application"
+
+      env = options[:production] ? :production : :development
+      Archsight::Web::Application.configure_environment!(env, logging: options[:enable_logging])
+      Archsight::Web::Application.set :reload_enabled, !options[:disable_reload]
       Archsight::Web::Application.setup_mcp!
       Archsight::Web::Application.run!(port: options[:port], bind: options[:host])
     rescue Archsight::ResourceError => e

lib/archsight/web/application.rb

@@ -35,13 +35,30 @@ def reload!
       dur = (Time.new - start) * 1000
       puts format("== done %0.2f ms", dur) if database.verbose
     end
+
+    # Configure application for the given environment
+    # @param env [Symbol] :development or :production
+    # @param logging [Boolean, nil] Override default logging setting
+    def configure_environment!(env, logging: nil)
+      set :environment, env
+
+      if env == :production
+        set :quiet, true
+        set :server_settings, { Silent: true }
+      end
+
+      # Determine logging: CLI override > env default (prod=true, dev=false)
+      enable_logging = logging.nil? ? (env == :production) : logging
+      use Rack::CommonLogger, $stdout if enable_logging
+    end
   end
 
   configure do
     set :views, File.join(__dir__, "views")
     set :public_folder, File.join(__dir__, "public")
     set :haml, format: :html5
     set :server, :puma
+    set :reload_enabled, true
   end
 
   # MCP Server setup
@@ -74,6 +91,18 @@ def db
       Archsight::Web::Application.database
     end
 
+    def reload_enabled?
+      settings.reload_enabled
+    end
+
+    def production?
+      settings.environment == :production
+    end
+
+    def development?
+      settings.environment == :development
+    end
+
     # Render markdown to HTML with optional URL resolution for repository content
     # @param data [String] Markdown content
     # @param git_url [String, nil] Git URL for resolving relative paths (e.g., for README images)
@@ -126,6 +155,8 @@ def render_analysis_section(section)
   end
 
   get "/reload" do
+    halt 404, "Reload is disabled" unless settings.reload_enabled
+
     Archsight::Web::Application.reload!
     if params["redirect"]&.start_with?("/")
       redirect params["redirect"]

lib/archsight/web/views/partials/layout/_navigation.haml

@@ -5,10 +5,11 @@
         %a{href: "/"}
           %i.iconoir-home
           Archsight
-    %li
-      %a{href: "/reload?redirect=#{request.path_info}"}
-        %i.iconoir-reload-window
-        Reload
+    - if reload_enabled?
+      %li
+        %a{href: "/reload?redirect=#{request.path_info}"}
+          %i.iconoir-reload-window
+          Reload
   %ul
     %li.search-container
       %a.search-help{ href: "/doc/index", "hx-get": "/doc/index", "hx-target": ".content", "hx-swap": "innerHTML", "hx-push-url": "true", title: "Help" }

test/import/progress_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "archsight/import"
 require "archsight/import/progress"
 require "stringio"
 

test/import/shared_file_writer_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "archsight/import"
 require "archsight/import/shared_file_writer"
 require "tmpdir"
 require "fileutils"