silkedit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4ee9527ffb968b57d0556c8242b44bfe50c69e78fe39734f92dcdf288efe6a1
+  data.tar.gz: 2eef2395c25e5a699230448b2ee31444cfee96654ad0572e6a4c9bd4cf5e26d8
+SHA512:
+  metadata.gz: 1562247f9866ae1eeb45e751e743b258b75c2303515a92deeb4c5dac8313d90111afc6cbc8c9abd43ac994dd682d0c88f44c6fbf8b7db5b03042c0a800402adb
+  data.tar.gz: 4de97c89ccf2e6c35c43b79600b3f0500daeae87218c394601f9a4a4a87ca13124f3f1996bf2537b9e202afcbf02396d60637c912478d70636b284dd910972ce

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-10-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,302 @@
+# Silkedit
+
+Silkedit is a tool that allows quick and easy editing of savefiles for Hollow Knight and Silksong.
+
+It has built-in cheats, can zone the player to nearly any bench or spawn point in the game (such as spawning where you obtain a skill), can edit the enemy journal to quickly update all required kills, and can save and restore the state of savefiles to provide you with a much larger save capacity.
+
+What's useful to note is that the game has a few seconds in between when you exit a game and when the main menu gets loaded during which you can apply cheats to your savefile. This means that you don't have to exit out of the game to reload your cheats - just quit to the main menu and run silkedit before it loads.
+
+Basic usage:
+
+```bash
+# Either supply the savegame number directly...
+silkedit -s 1 cheat max_health max_silk quill_purple
+
+# ...or keep it in an environment variable
+export SILKEDIT_SAVENUM=1
+silkedit cheat max_health max_silk quill_purple
+
+# Un-kill your character, even in Silk Soul Mode
+silkedit cheat unkill
+
+# List all cheats and zones
+silkedit cheat -l
+silkedit zone -l
+
+# Spawn at a different point when reloading the game
+silkedit zone terminus
+
+# Analyze or edit your enemy kill records
+# If you have a terminal emulator compatible with `imgcat`
+# (such as iterm2), images of the enemies will also be displayed.
+silkedit journal listall
+silkedit journal listmissing
+silkedit journal killsonly
+silkedit journal complete
+
+# Or load up a pre-defined savefile to any slot
+silkedit permaload -n act3complete
+```
+
+All available commands:
+```
+$ silkedit -h
+  backup         Backs up the savefile
+  restore        Restore a backup to the savefile. Providing no parameters restores the latest backup.
+  cheat          Applies one or more cheats to the selected savefile
+  edit           Edit the savefile directly
+  diff           Diffs the current savegame against the latest backup, a specified backup, or a different save
+  journal        Manages the journal of enemy kills
+  permasave      Saves a local copy of a game into the config to restore later.
+  permaload      Restores a permasave into the slot
+  unpack         Unpacks a save file or backup to JSON/YAML for manual editing
+  repack         Packs the JSON/YAML to the savefile
+  zone           Zones the character to a different respawn point
+  mkzone         Adds a new spawn point to the library
+```
+
+Available cheats:
+
+```
+$ silkedit cheat -l
+all_abilities
+all_crest_unlocks
+all_crests
+all_eva_upgrades
+all_fasttravel
+all_fleas
+all_maps
+all_spells
+all_tools
+complete_mushroom_quest
+easy_dice_game_win
+easy_flea_games_win
+give_consumables
+give_farsight
+max_everything
+max_health
+max_liquids
+max_rosaries
+max_shards
+max_silk
+max_tool_upgrades
+max_weapon
+quill_none
+quill_purple
+quill_red
+quill_white
+refresh
+toggle_cloakless
+toggle_flea_reveal
+toggle_map_reveal
+toggle_permadeath_mode
+unkill
+unlock_terminus_door
+```
+
+Available Spawn Points
+
+Note: The act shown is the expected act in the game when you'd normally get there. In most cases, however, you can ignore it and spawn anywhere during any act. Notable exceptions are the flea games during Act 1/2, or fleatopia during act 3. These will cause glitches.
+
+```
+$ silkedit zone -l
+Shortcuts:
+     bonebottom        greymoor    blastedsteps             spa       fleatopia
+          druid     halfwayhome       pinstress       highhalls       fleagames
+         marrow         yarnaby     sinnersroad        terminus         surface
+          docks        bellhart       bilewater       architect     weavenest_a
+          sauna        bellhome    exhaustorgan         faypeak     weavenest_c
+      farfields           widow           ducts       fleacamp1           abyss
+     seamstress       shellwood         cogcore       fleacamp2
+   huntersmarch       alchemist       songclave       fleacamp3
+
+Zones:
+Shortcut     Act Zone
+               3 abyss.bell_fixed
+               3 abyss.north
+abyss          3 abyss.south
+bellhome       2 bellhart.bellhome
+bellhart       1 bellhart.bench
+               1 bellhart.widow_bellshrine
+widow          1 bellhart.widow_spawn
+               2 bilewater.bilehaven
+               2 bilewater.east
+exhaustorgan   1 bilewater.exhaustorgan
+bilewater      1 bilewater.station
+pinstress      1 blastedsteps.pinstress
+               1 blastedsteps.south
+blastedsteps   1 blastedsteps.station
+surface        3 bordercaves.bench
+               2 choralchambers.center
+               2 choralchambers.northwest
+               2 choralchambers.southwest
+spa            2 choralchambers.spa
+cogcore        2 cogcore.bench
+               2 cogcore.dancers_spawn
+               2 cogcore.melodytowers_spawn
+               3 cradle.destroyed
+               2 cradle.lace_spawn
+terminus       1 cradle.terminus
+               3 deepdocks.bell_fixed
+               1 deepdocks.bellshrine
+               1 deepdocks.dash_spawn
+docks          1 deepdocks.forgedaughter
+               3 deepdocks.fromabyss
+sauna          2 deepdocks.sauna
+               1 deepdocks.upper
+               3 farfields.act3area
+               1 farfields.pilgrimsrest
+seamstress     1 farfields.seamstress
+               3 farfields.sprintmaster
+farfields      1 farfields.station
+               1 farfields.upperentrance
+weavenest_c    1 farfields.weavenest_cindril
+               2 fay.cave
+               2 fay.climb
+faypeak        2 fay.peak
+               2 fay.shakra
+               1 grandbellway.station
+fleacamp3      2 grandgate.fleacamp_3
+greymoor       1 greymoor.bellshrine
+fleacamp2      1 greymoor.fleacamp_2
+halfwayhome    1 greymoor.halfwayhome
+               1 greymoor.reaper_crest_spawn
+               1 greymoor.shakra
+               1 greymoor.yarnaby_spawn
+               2 highhalls.station
+huntersmarch   1 huntersmarch.trappedbench
+               2 karak.coraltower
+               2 karak.east
+               1 marrow.entrance
+fleacamp1      1 marrow.fleacamp_1
+               1 marrow.jail_pinchallenge
+marrow         1 marrow.station_bellshrine
+               2 memorium.default
+               1 memory.needolin
+bonebottom     1 mossgrove.bonebottom
+               1 mossgrove.chapel
+               3 mossgrove.chapel_inside
+druid          1 mossgrove.druid
+               1 mossgrove.gamestart_respawn
+               1 mossgrove.mosshome
+               3 mossgrove.shaman_crest_spawn
+               1 mossgrove.silkspear_spawn
+               1 mossgrove.wanderer_crest_spawn
+               3 putrifiedducts.fleafestival
+fleatopia      2 putrifiedducts.fleatopia
+               2 putrifiedducts.huntress
+ducts          2 putrifiedducts.station
+               1 shellwood.center
+               1 shellwood.clinggrip_respawn
+               3 shellwood.nyleth_spawn
+               2 shellwood.south
+shellwood      1 shellwood.station_bellshrine
+               1 shellwood.west
+               2 shellwood.witch_crest_spawn
+               1 sinnersroad.east
+               1 sinnersroad.east_permadeathmode
+sinnersroad    1 sinnersroad.west
+               1 slab.east
+               2 slab.firstsinner_spawn
+               1 slab.nw_inside
+               1 slab.nw_outside
+               1 slab.station
+               2 songclave.bellshrine
+songclave      2 songclave.bench
+architect      2 underworks.architect
+               2 underworks.harpoon_spawn
+               2 underworks.north_a
+               2 underworks.north_b
+               2 underworks.north_c
+               2 underworks.west
+               3 verdania.bench
+               1 weavenest.atla_bench
+               1 weavenest.atla_eva_spawn
+               2 whisperingvaults.keeper
+               2 whisperingvaults.south
+               2 whiteward.default
+               2 wispthicket.default
+alchemist      1 wormways.alchemist
+               2 wormways.sharpdart_spawn
+```
+
+Provided Permasaves:
+
+```
+$ silkedit permaload -l
+standard_mode_complete
+silksoul_mode_complete
+act3complete
+act2complete
+act1complete
+act1speedrun
+act2_pre_lace_and_witch
+cursed_mother_kill
+act3start
+```
+
+Example journal update (without images):
+
+It asks for confirmation for any mob which has less than 10 required kills, as many of those have only a fixed number in game and not everyone may want to update them.
+
+```
+$ silkedit journal complete
+(...)
+  Great Conchfly              Seen? Y Kills:    1 Needed:    2 Left:    1
+    Set Great Conchfly kills from 1 to 2? (y/n): n
+* Roachfeeder                 Seen? Y Kills:   20 Needed:   20 Left:    0
+    Already Completed.
+* Roachkeeper                 Seen? Y Kills:   10 Needed:   10 Left:    0
+    Already Completed.
+  Last Judge                  Seen? N Kills:    0 Needed:    1 Left:    1
+    Added to journal.
+  Underpoke                   Seen? N Kills:    0 Needed:   25 Left:   25
+(...)
+```
+
+
+## Installation
+
+Silkedit is available on **rubygems**, and *should* work cross-platform. I don't own an x86 Windows system to test it but if you have one and find that it doesn't work, feel free to submit a bug report or pull request!
+
+```bash
+gem install silkedit
+```
+
+If you don't already have ruby on your system, you will need to install it.
+
+### Windows
+
+[https://rubyinstaller.org/downloads/](https://rubyinstaller.org/downloads/)
+
+### MacOS
+
+```bash
+# Install Homebrew
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+# Install rbenv
+brew install rbenv
+# Install ruby
+rbenv install "$(rbenv install -l | grep -v - | tail -1)"
+```
+
+### Linux
+
+[https://github.com/rbenv/rbenv?tab=readme-ov-file#using-package-managers](https://github.com/rbenv/rbenv?tab=readme-ov-file#using-package-managers)
+
+If you already have ruby on your system, just run:
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akhoury6/silkedit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/silkedit/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Silkedit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/silkedit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/silkedit

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+################
+### Silkedit ###
+################
+
+#require 'rbcli'
+require '/Users/andrew/Documents/code/rbcli/lib/rbcli.rb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'silkedit')
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'config', '*.rb')].each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'commands', '*.rb')].each { |file| require file }
+
+Rbcli.go!

data/lib/commands/backup_restore.rb

@@ -0,0 +1,25 @@
+Rbcli.command 'backup' do
+  description 'Backs up the savefile'
+  parameter :custom_name, 'Give the backup a custom name. Named backups can\'t be edited.', short: :n, type: :string
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.direct_backup(backup_name: params[:custom_name])
+  end
+end
+
+Rbcli.command 'restore' do
+  description 'Restore a backup to the savefile. Providing no parameters restores the latest backup.'
+  parameter :backup_seq, 'Backup number to restore (Can\'t use together with named backup)', short: :b, type: :integer
+  parameter :backup_name, 'Named backup to restore', short: :n, type: :string
+
+  action do |opts, params, args, config, env|
+    if !params[:backup_seq].nil? && !params[:backup_name].nil?
+      Rbcli.log.error 'Can\'t specify both a sequence and name at the same time.'
+    else
+      s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+      unless s.direct_restore(seq_number: params[:backup_seq], backup_name: params[:backup_name])
+        Rbcli.log.error "Failed to restore backup"
+      end
+    end
+  end
+end

data/lib/commands/cheat.rb

@@ -0,0 +1,19 @@
+Rbcli.command 'cheat' do
+  description 'Applies one or more cheats to the selected savefile'
+  usage '<cheat1> <cheat2> <cheat3>...'
+  parameter :list, 'List all cheats', type: :bool, default: false
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    c = Silkedit::Cheat::Engine.new(s.data)
+    selected_cheats = args.map { |arg| arg.downcase }.select { |cht| c.cheat_exists?(cht) }
+    if params[:list] || selected_cheats.empty?
+      Rbcli.log.info "Cheats: \n" + c.list_cheats.map(&:to_s).join("\n")
+    else
+      selected_cheats.each { |cht| c.apply_cheat(cht) }
+      s.direct_backup
+      # s.save_to_dat
+      Rbcli.log.info "applied cheats: #{selected_cheats.join(', ')}"
+    end
+  end
+end

data/lib/commands/edit_diff.rb

@@ -0,0 +1,47 @@
+Rbcli.command 'edit' do
+  description 'Edit the savefile directly'
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    s.save_to_json
+    Process.wait(Process.spawn(config[:editor_command].sub('%FILE%', s.filenames[:json])))
+    if Silkedit::Sys.yes_no?('Apply changes?')
+      s.load_from_json
+      s.direct_backup
+      s.save_to_dat
+      Rbcli.log.info 'Updated savefile'
+    else
+      Rbcli.log.info 'Aborted'
+    end
+  end
+end
+
+Rbcli.command 'diff' do
+  description 'Diffs the current savegame against the latest backup, a specified backup, or a different save'
+  parameter :backup_seq, 'Backup number to diff against', short: :b, type: :integer
+  parameter :othersave, 'Other save number to diff against', short: :o, type: :integer
+  parameter :yaml_output, 'Output in YAML instead of a Ruby object', short: :y, type: :boolean
+
+
+  action do |opts, params, args, config, env|
+    new = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    new.load_from_dat
+    if params[:othersave]
+      old = Silkedit::Savegame::SaveFile.new(:silksong, params[:othersave])
+      old.load_from_dat
+    else
+      old = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+      old.load_from_backup(seq_number: params[:backup_seq])
+    end
+
+    diff = Silkedit::Savegame::Diff.mkdiff(old.data, new.data)
+    Rbcli.log.info Silkedit::Savegame::Diff.parse_diff(diff, yaml_output: params[:yaml_output])
+
+    # s.save_as_json
+    # FileUtils.mv(s.json_filename, "#{s.json_filename}.old")
+    # s.load_from_dat
+    # s.save_as_json
+    # FileUtils.mv(s.json_filename, "#{s.json_filename}.new")
+    # Process.wait(Process.spawn(config[:diff_command].sub('%OLD%', "#{s.json_filename}.old").sub('%NEW%', "#{s.json_filename}.new")))
+  end
+end

data/lib/commands/examples/command.rb

@@ -0,0 +1,51 @@
+Rbcli.command "example" do
+  ##### Command Declaration (At least one is required) #####
+  # default     (Optional) The default command is run when no other commands are called on the CLI
+  #               Note that parameters are not available for default commands, as all CLI options
+  #               are parsed against the global-level ones declared in the `Configurate.opts` block
+  # description (Optional) Short description that shows up in --help for the executable
+  # usage       (Optional) Usage text that shows up in --help or when CLI format is bad
+  # helptext    (Optional) Large help text that shows up in --help for the command
+  # default
+  description 'Example command'
+  usage "[--param|--otherparam] name"
+  helptext <<~EOF
+    Big block of helptext
+  EOF
+  # parameter (Optinoal) Parameters follow the same format as CLI Options, but are only available for this command
+  parameter :param, 'A Parameter', default: false
+  parameter :otherparam, 'Another Parameter', type: :string, default: "Default value"
+  # action    (Required, unless declaring a `script`) The action block is code that gets executed when the command is called
+  #             Sending all output through the logger is recommended. For it to be displayed
+  #             as regular text, set the logger to the :display format
+  action do |opts, params, args, config, env|
+    Rbcli.log.info "Welcome to your new application!"
+    Rbcli.log.info "We like to send all of our output through the logger for easy formatting and deployment..."
+    puts "...but you don't have to"
+    Rbcli.log.info "Here's a quick demo of how to use the framework:\n"
+
+    Rbcli.log.info "Top-level CLI Options: " + opts.to_s
+    Rbcli.log.info "Parameters:            " + params.to_s
+    Rbcli.log.info "Arguments on the CLI:  " + args.to_s
+    Rbcli.log.info "The config:            " + config.to_s
+    Rbcli.log.info "Environment variables: " + env.to_s
+    Rbcli.log.info ""
+
+    Rbcli.log.debug "Example Debug Message (change your log level to see this!)", "MYAPP"
+    Rbcli.log.info "Example Info Message", "MYAPP"
+    Rbcli.log.warn "Example Warning Message", "MYAPP"
+    Rbcli.log.error "Example Error Message", "MYAPP"
+    Rbcli.log.fatal "Example Fatal Message", "MYAPP"
+    Rbcli.log.unknown "Example Unknown Message", "MYAPP"
+    Rbcli.log.info ""
+
+    config.add_default :foo, 'bar'
+    config.create!
+    config.load!
+    config[:davey] = 'Davey Jones'.compress
+    Rbcli.log.info "Compressed String: " + config[:davey]
+    Rbcli.log.info "Decompressed String: " + config[:davey].decompress
+    config.save!
+    Rbcli.log.info config
+  end
+end

data/lib/commands/examples/script.rb

@@ -0,0 +1,36 @@
+# Script Command
+# Supports all of the same features as a regular command, but passes everything to a bash script
+# The script can be defined inline, or a path to an external script can be provided
+#
+# Code is injected into the script to integrate with Rbcli.
+#   The `log` commands are integrated with the ruby logger
+#   The `rbcli` command provides a wrapper around jq that can retrieve
+#     the values of opts/params/args/config/env
+#   For more information on JQ syntax, see: https://jqlang.github.io/jq/
+Rbcli.command "script" do
+  description "example script command"
+  # external_script vars: {}, path: "./test.sh"
+  inline_script vars: { foo: 'bar!!!' }, inline: <<~INLINE
+    #!/usr/bin/env bash
+    log "Rbcli shell integration demo!"
+    log "A custom JQ wrapper is used to parse config passed through from Rbcli"
+    log "For more information on how to use it, see: https://jqlang.github.io/jq/"
+    log ""
+
+    log "Top-level CLI Options: $(rbcli opts .)"
+    log "Parameters: $(rbcli params .)"
+    log "Arguments on the CLI: $(rbcli args .)"
+    log "Config: $(rbcli config .)"
+    log "Environment Variables: $(rbcli env .)"
+    log "Custom Var from command: $(rbcli vars .foo)"
+    log "Same variable, in environment: ${FOO}"
+
+    log "Logs are integrated too"
+    log "Example Debug (you need to change your log level to see this)" "debug"
+    log "Example Info" "info"
+    log "Example Warning" "warn"
+    log "Example Error" "error"
+    log "Example Fatal" "fatal"
+    log "Example Unknown" "unknown"
+  INLINE
+end