Class: KamalBackup::CLI

Inherits:

Thor

• Object
• Thor
• KamalBackup::CLI

Includes:

Helpers

Defined in:

lib/kamal_backup/cli.rb

Defined Under Namespace

Modules: Helpers Classes: CommandBase, DrillCLI, RestoreCLI

Class Attribute Summary

• .command_env ⇒ Object

  Returns the value of attribute command_env.

Class Method Summary

• .basename ⇒ Object
• .normalize_global_options(argv) ⇒ Object
• .start(argv = ARGV, env: ENV) ⇒ Object

Instance Method Summary

• #backup ⇒ Object
• #check ⇒ Object
• #evidence ⇒ Object
• #init ⇒ Object
• #list ⇒ Object
• #schedule ⇒ Object
• #validate ⇒ Object
• #version ⇒ Object

Methods included from Helpers

#accessory_name, #accessory_reboot_command, #bridge, #command_env, #confirm!, #default_deploy_config?, #deploy_snippet, #deployment_mode?, #direct_app, #ensure_remote_version_match!, #exec_remote, #init_config_root, #local_app, #local_command_config, #local_preferences, #print_remote_version_status, #production_source_defaults, #prompt_required, #redactor, #remote_version, #shared_config_path, #shared_config_source_defaults, #shared_config_template, #validate_deploy_config, #validate_deploy_mode?, #version_remote_mode?, #write_init_file

Class Attribute Details

.command_env ⇒ Object

Returns the value of attribute command_env.

# File 'lib/kamal_backup/cli.rb', line 305

def command_env
  @command_env
end

Class Method Details

.basename ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 343

def self.basename
  "kamal-backup"
end

.normalize_global_options(argv) ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 307

def normalize_global_options(argv)
  tokens = Array(argv).dup
  leading = []

  while tokens.any?
    token = tokens.first

    case token
    when "-d", "--destination", "-c", "--config-file"
      leading << tokens.shift
      leading << tokens.shift if tokens.any?
    when /\A--destination=.+\z/, /\A--config-file=.+\z/
      leading << tokens.shift
    else
      break
    end
  end

  if leading.empty? || tokens.empty?
    Array(argv)
  else
    [tokens.shift, *leading, *tokens]
  end
end

.start(argv = ARGV, env: ENV) ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 347

def self.start(argv = ARGV, env: ENV)
  self.command_env = env
  super(normalize_global_options(argv))
rescue Error => e
  warn("kamal-backup: #{Redactor.new(env: env).redact_string(e.message)}")
  exit(1)
rescue Interrupt
  warn("kamal-backup: interrupted")
  exit(130)
ensure
  self.command_env = nil
end

Instance Method Details

#backup ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 363

def backup
  if deployment_mode?
    exec_remote(["kamal-backup", "backup"])
  else
    direct_app.backup
  end
end

#check ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 381

def check
  if deployment_mode?
    exec_remote(["kamal-backup", "check"])
  else
    puts(direct_app.check)
  end
end

#evidence ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 390

def evidence
  if deployment_mode?
    exec_remote(["kamal-backup", "evidence"])
  else
    puts(direct_app.evidence)
  end
end

#init ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 410

def init
  write_init_file(shared_config_path, shared_config_template)

  puts
  puts "Add this accessory block to your Kamal deploy config:"
  puts
  puts deploy_snippet
  puts
  puts "The accessory runs scheduled database and Active Storage backups with backup_schedule_seconds."
  puts "For most Rails apps, restore local and drill local can infer the development database, Active Storage path, and tmp state directory."
  puts "Local restore and drill also require the restic binary on your machine."
  puts "Create config/kamal-backup.local.yml only if you need to override those local defaults."
end

#list ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 372

def list
  if deployment_mode?
    exec_remote(["kamal-backup", "list"])
  else
    puts(direct_app.snapshots)
  end
end

#schedule ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 425

def schedule
  if deployment_mode?
    exec_remote(["kamal-backup", "schedule"])
  else
    direct_app.schedule
  end
end

#validate ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 399

def validate
  if validate_deploy_mode?
    validate_deploy_config
  else
    direct_app.validate
  end

  puts("ok")
end

#version ⇒ Object

# File 'lib/kamal_backup/cli.rb', line 434

def version
  if version_remote_mode?
    print_remote_version_status
  else
    puts(VERSION)
  end
end