2021-02-13 09:19:03 -08:00
|
|
|
#!/usr/bin/env cached-nix-shell
|
|
|
|
#! nix-shell -p ruby -i "ruby -S" --quiet
|
|
|
|
|
|
|
|
DESC = <<~DESC
|
|
|
|
Nix's CLI has a poor user story, in my opinion. It could be better; Guix is a
|
|
|
|
good role model here. I wrote this script to abstract the more common
|
|
|
|
workflows, like rebuilding (nixos-rebuild), cleaning up (nix-collect-garbage),
|
|
|
|
package/env management (nix-env), updating, rolling back, etc. As well as some
|
|
|
|
utility operations (like managing generations, building remotely, or swapping
|
|
|
|
themes on the fly).
|
|
|
|
|
|
|
|
Because I can go months without shaving yaks in NixOS, exact flags or details
|
|
|
|
are often and easily forgotten. This spares me that fumbling phase and also
|
|
|
|
serves as a reference.
|
|
|
|
|
|
|
|
Note: `hey` can also be used as a shortcut for nix-env:
|
|
|
|
|
|
|
|
hey -q
|
|
|
|
hey -iA nixos.htop
|
|
|
|
hey -e htop
|
|
|
|
DESC
|
|
|
|
|
|
|
|
require 'shellwords'
|
|
|
|
require 'optparse'
|
|
|
|
|
|
|
|
module Hey
|
|
|
|
extend self
|
|
|
|
Command = Struct.new(:name, :desc, :args, :opts, :fn)
|
|
|
|
|
|
|
|
@@opts = { flake: File.expand_path('../', File.dirname(__FILE__)) }
|
|
|
|
@@alias = {}
|
|
|
|
@@commands = {}
|
|
|
|
@@cli = nil
|
|
|
|
def self.defcmd names, &block
|
|
|
|
names = (names.kind_of?(Array) ? names : [names]).map(&:to_s)
|
|
|
|
names.drop(1).each { |n| @@alias[n] = names.first }
|
|
|
|
cli = Command.new names.first, [], []
|
|
|
|
cli.opts = OptionParser.new do |opt|
|
|
|
|
opt.banner = "Usage: #{opt.program_name} #{cli.name} [options]"
|
|
|
|
opt.separator "\nOptions:"
|
|
|
|
opt.on_tail('-h', '--help', 'Prints this help') { puts opt; exit }
|
|
|
|
end
|
|
|
|
@@cli = cli
|
|
|
|
fn = block.call cli
|
|
|
|
cli.fn = lambda do |args|
|
|
|
|
begin
|
|
|
|
cli.opts.banner +=
|
|
|
|
(cli.args ? " #{cli.args.join ' '}" : "") +
|
|
|
|
(cli.desc ? "\n\n#{cli.desc[0]}\n\n#{cli.desc[1..].join "\n"}" : "")
|
|
|
|
cli.opts.order!(args, into: @@opts)
|
|
|
|
fn.call args
|
|
|
|
ensure @@cli = nil end
|
|
|
|
end
|
|
|
|
@@commands[cli.name] = @@cli
|
|
|
|
end
|
|
|
|
def self.opts(*args) @@cli.opts.on(*args) end
|
|
|
|
def self.args(*args) @@cli.args = args end
|
|
|
|
def self.desc(*args) @@cli.desc = args end
|
|
|
|
def self.sh(args, sudo: false, noerror: false)
|
|
|
|
raise ArgumentError unless args.kind_of?(Array)
|
|
|
|
args.unshift('sudo') if sudo
|
|
|
|
if @@opts[:dryrun]
|
|
|
|
print args.compact
|
|
|
|
return true
|
2020-10-01 15:46:04 -07:00
|
|
|
else
|
2021-02-13 09:19:03 -08:00
|
|
|
result = system "#{args.compact.shelljoin} 2>&1"
|
|
|
|
noerror ? result : exit($?.exitstatus)
|
|
|
|
end
|
|
|
|
end
|
2021-02-14 11:43:48 -08:00
|
|
|
def self.rebuild(*args, sudo: false, host: nil)
|
|
|
|
host ||= ENV['HOST'] || `hostname`.rstrip
|
2021-02-13 09:19:03 -08:00
|
|
|
sh ["nixos-rebuild",
|
2021-02-14 11:43:48 -08:00
|
|
|
"--flake", "#{@@opts[:flake]}##{host}",
|
2021-02-13 09:19:03 -08:00
|
|
|
"--option", "pure-eval", "no",
|
|
|
|
*args], sudo: sudo
|
|
|
|
end
|
|
|
|
|
|
|
|
#
|
|
|
|
defcmd [:shell, :sh] do
|
|
|
|
desc "Open a nix-shell with the dotfiles loaded"
|
|
|
|
lambda do |args|
|
|
|
|
sh ["nix", "develop", args.first || @@opts[:flake]]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :repl do
|
|
|
|
desc "Open a nix-repl with nixpkgs and dotfiles preloaded"
|
|
|
|
lambda do |args|
|
|
|
|
sh ["nix", "repl", @@opts[:flake], "<nixpkgs>", *args]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:check, :ch] do
|
|
|
|
desc "Run 'nix flake check' on your dotfiles"
|
|
|
|
lambda do |args|
|
|
|
|
sh ["nix", "flake", "check", @@opts[:flake]]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :show do
|
|
|
|
desc "[ARGS...]", "Run 'nix flake show' on your dotfiles"
|
|
|
|
lambda do |args|
|
|
|
|
sh ["nix", "flake", "show", @@opts[:flake]]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :theme do
|
|
|
|
desc 'Quickly swap to another theme module'
|
|
|
|
args "THEME_NAME"
|
|
|
|
lambda do |args|
|
|
|
|
ENV["THEME"] = args.shift
|
|
|
|
rebuild "--fast", "test"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:test, :t] do
|
|
|
|
desc "Quickly rebuild, for quick iteration"
|
|
|
|
lambda do |args|
|
|
|
|
rebuild "--fast", "test", *args
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:rebuild, :re] do
|
|
|
|
desc "Rebuild the current system's flake"
|
|
|
|
opts '--build-host HOST', "TODO"
|
|
|
|
opts '--target-host HOST', "TODO"
|
|
|
|
opts '--host HOST', "TODO"
|
|
|
|
opts '--user', "TODO"
|
|
|
|
opts '--fast', "TODO"
|
|
|
|
lambda do |args|
|
|
|
|
Dir.chdir(@@opts[:flake]) do
|
|
|
|
args = ["switch"] unless args.length > 0
|
|
|
|
rebuild(*(@@opts[:"build-host"] ? ["--build-host", @@opts[:"build-host"]] : []),
|
|
|
|
*(@@opts[:"target-host"] ? ["--target-host", @@opts[:"target-host"]] : []),
|
|
|
|
@@opts[:fast] ? "--fast" : nil,
|
|
|
|
@@opts[:debug] ? "--show-trace" : nil,
|
|
|
|
*args,
|
2021-02-14 11:43:48 -08:00
|
|
|
sudo: !@@opts[:user],
|
|
|
|
host: @@opts[:host])
|
2021-02-13 09:19:03 -08:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :rollback do
|
|
|
|
desc "Roll back to last generation"
|
|
|
|
lambda do |_args|
|
|
|
|
rebuild "--rollback", "switch"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:update, :u] do
|
|
|
|
desc "Update specific flakes or all of them"
|
|
|
|
args "[INPUT...]"
|
|
|
|
lambda do |args|
|
|
|
|
args.each do |flake|
|
|
|
|
puts "Trying to update #{flake}..."
|
|
|
|
sh ["nix", "flake", "update", "--update-input", flake, @@opts[:flake]]
|
|
|
|
end.empty? and begin
|
|
|
|
puts "Updating all flakes.."
|
|
|
|
sh ["nix", "flake", "update", "--recreate-lock-file", @@opts[:flake]]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:upgrade, :up] do
|
|
|
|
desc "Update all flakes and rebuild system"
|
|
|
|
lambda do |_args|
|
|
|
|
update
|
|
|
|
rebuild :switch
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd [:search, :s] do
|
|
|
|
desc "Search nixpkgs for a package"
|
|
|
|
lambda do |args|
|
|
|
|
sh ["nix", "search", "nixpkgs", *args]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :swap do
|
|
|
|
desc "Recursively swap nix-store links (or folders thereof) with copies.",
|
|
|
|
"The purpose is so you can have copies of your dotfiles that can be modified in",
|
|
|
|
"place (so you can iterate on them quickly instead of 'hey re'ing between",
|
|
|
|
"changes). Run again to restore the old link(s).\n",
|
|
|
|
"Warning: backup your copies, or they will be destroyed when restored!"
|
|
|
|
args "PATH", "[PATHS...]"
|
|
|
|
lambda do |args|
|
|
|
|
for target in args
|
|
|
|
if File.directory? target
|
|
|
|
files = Dir.glob("#{target}/**/*.nix-store-backup")
|
|
|
|
if files.length > 0
|
|
|
|
puts "There are swapped files here. Unswapping!"
|
|
|
|
call :swap, *files
|
|
|
|
else
|
|
|
|
puts "Swapping files in #{target}"
|
|
|
|
call :swap, *(Dir.glob("#{target}/**/*")
|
|
|
|
.select { |f| File.symlink? f }
|
|
|
|
.select { |l| File.readlink(l).match '^/nix/store/' })
|
|
|
|
end
|
|
|
|
elsif File.file? "#{target}.nix-store-backup"
|
|
|
|
puts "Unswapping #{target}"
|
|
|
|
sh [:mv, '-i', "#{target}.nix-store-backup", target]
|
|
|
|
elsif File.file? target
|
|
|
|
puts "Swapping #{target}"
|
|
|
|
sh [:mv, target, "#{target}.nix-store-backup"]
|
|
|
|
sh [:cp, "#{target}.nix-store-backup", target]
|
2020-10-17 13:48:08 -07:00
|
|
|
else
|
2021-02-13 09:19:03 -08:00
|
|
|
puts "Not a valid target: #{target}"
|
|
|
|
exit 1
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :gc do
|
|
|
|
desc "Garbage collect & optimize nix store"
|
|
|
|
opts "-a", "--all", "GC both the user and system profiles"
|
|
|
|
opts "-s", "--system", "Only GC the system profile"
|
|
|
|
lambda do |_args|
|
|
|
|
if @@opts[:all] or not @@opts[:root]
|
|
|
|
puts "Cleaning up your user profile..."
|
|
|
|
sh %w{nix-collect-garbage -d}
|
|
|
|
end
|
|
|
|
if @@opts[:all] or @@opts[:system]
|
|
|
|
puts "Cleaning up your system..."
|
|
|
|
sh %w{nix-collect-garbage -d}, sudo: true
|
|
|
|
sh %w{nix-store --optimise}, sudo: true
|
|
|
|
# Clear out left-over secrets. The switch-to-configuration call below will
|
|
|
|
# regenerate them.
|
|
|
|
if File.exists?("/run/secrets/*")
|
|
|
|
sh %w{rm -rf /run/secrets/*}, sudo: true
|
|
|
|
end
|
|
|
|
# nix-collect-garbage is a Nix tool, not a NixOS tool. It won't delete old
|
|
|
|
# boot entries until you do a nixos-rebuild (which means we'll always have
|
|
|
|
# 2 boot entries at any time). Instead, we properly delete them by
|
|
|
|
# reloading the current environment.
|
|
|
|
sh %w{nix-env --delete-generations old --profile /nix/var/nix/profiles/system}, sudo: true
|
|
|
|
sh %w{/nix/var/nix/profiles/system/bin/switch-to-configuration switch}, sudo: true
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defcmd :ssh do
|
|
|
|
desc "Run a Hey command on a remote NixOS system",
|
|
|
|
"This command assumes that the remote system is built on these dotfiles, it is",
|
|
|
|
"dangerous to do this if that isn't the case."
|
|
|
|
args "HOST", "[COMMAND]"
|
|
|
|
opts '--host HOST', "The nixos config to build and deploy to HOST"
|
|
|
|
lambda do |args|
|
|
|
|
target, command = args.take(2)
|
|
|
|
if command.match /switch|test|boot/
|
|
|
|
puts "Enabling root ssh access on #{target}. Enter root password for remote system:"
|
|
|
|
if sh ["ssh", "-t", target,
|
|
|
|
"sudo mkdir -p /root/.ssh && sudo cp -f ~/.ssh/authorized_keys /root/.ssh/"],
|
|
|
|
noerror: true
|
|
|
|
begin
|
|
|
|
puts "Building #{target}"
|
|
|
|
call "rebuild", ["--user",
|
|
|
|
"--host", @@opts[:host] || target,
|
|
|
|
"--build-host", "localhost",
|
|
|
|
"--target-host", "root@#{target}",
|
|
|
|
command || "test"]
|
|
|
|
ensure
|
|
|
|
puts "Undoing root ssh access on #{target}"
|
|
|
|
sh ["ssh", "-t", "root@#{target}", "rm -f /root/.ssh/authorized_keys"]
|
|
|
|
end
|
|
|
|
end
|
2020-10-17 13:48:08 -07:00
|
|
|
else
|
2021-02-13 09:19:03 -08:00
|
|
|
command = "nix run github:hlissner/dotfiles -- #{command}"
|
|
|
|
puts "Running '#{command}' on #{target}"
|
|
|
|
sh ["ssh", "-t", target, command]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# TODO Generalize this to nix profiles
|
|
|
|
defcmd [:generations, :gen] do
|
|
|
|
desc "Explore, manage, diff across generations"
|
|
|
|
opts '--diff FROM TO', "TODO"
|
|
|
|
opts '-r', '--remove PROFILE', "TODO"
|
|
|
|
lambda do |args|
|
|
|
|
profile = "/nix/var/nix/profiles/system"
|
|
|
|
case args.shift
|
|
|
|
when "diff"
|
|
|
|
from, to = *args
|
|
|
|
if from == to
|
|
|
|
puts "Comparing the same profile! Aborting..."
|
2021-01-24 10:06:03 -08:00
|
|
|
exit 1
|
2021-02-13 09:19:03 -08:00
|
|
|
elsif [from, to].compact.select do |gen|
|
|
|
|
File.exists? "#{profile}-#{gen}-link" or
|
|
|
|
puts "Generation #{gen} does not exist!"
|
|
|
|
end.length != [from, to].compact.length
|
|
|
|
exit 2
|
|
|
|
end
|
|
|
|
from = from ? "#{profile}-#{from}-link" : profile
|
|
|
|
to = to ? "#{profile}-#{to}-link" : profile
|
|
|
|
fromDevs = `nix-store -q --references #{from}`.split
|
|
|
|
toDevs = `nix-store -q --references #{to}`.split
|
|
|
|
puts (fromDevs - toDevs).map { |d| "\e[31m-#{d}\e[0m" }
|
|
|
|
puts (toDevs - fromDevs).map { |d| "\e[32m+#{d}\e[0m" }
|
|
|
|
when /ls|list/
|
|
|
|
sh ["nix-env", "--list-generations", "--profile", profile], sudo: true
|
|
|
|
when "remove"
|
|
|
|
sh ["nix-env", "--delete-generations", "--profile", profile, *args], sudo: true
|
|
|
|
when "switch"
|
|
|
|
puts "Targeted rollback not supported yet" # TODO Is this true?
|
|
|
|
exit 1
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
class UsageError < StandardError; end
|
|
|
|
defcmd [:help, :h] do
|
|
|
|
desc "Show usage information for this script or a subcommand"
|
|
|
|
args "[SUBCOMMAND]"
|
|
|
|
lambda do |args|
|
|
|
|
raise UsageError unless args.first
|
|
|
|
call args.first, ["-h", *args.drop(1)]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
#
|
|
|
|
def self.call command, args
|
|
|
|
cmd = command.to_s
|
|
|
|
cmd = @@alias[cmd] while cmd and not @@commands.key?(cmd)
|
|
|
|
if cmd
|
|
|
|
@@commands[cmd].fn.call args
|
|
|
|
elsif command
|
|
|
|
puts "Couldn't recognize command '#{command}'"
|
|
|
|
exit 1
|
|
|
|
else
|
|
|
|
raise UsageError
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.run args=[]
|
|
|
|
opts = OptionParser.new do |opt|
|
|
|
|
opt.banner = "Usage: hey [global-options] [command] [sub-options]\n\n" + DESC
|
|
|
|
opt.separator "\n\nAvailable Commands:"
|
|
|
|
opt.separator (@@commands.values
|
|
|
|
.reject { |c| c.desc.empty? }
|
|
|
|
.sort { |a,b| a.name <=> b.name }
|
|
|
|
.map { |c| " %-18s %s\n" % ["#{c.name} #{@@alias.key(c.name)}",
|
|
|
|
c.desc[0]]})
|
|
|
|
opt.separator "\nOptions:"
|
|
|
|
opt.on('-d', '--dryrun', "Don't change anything; preform dry run")
|
|
|
|
opt.on('-D', '--debug', "Show trace on nix errors")
|
|
|
|
opt.on('-f', '--flake URI', "Change target flake to URI")
|
|
|
|
opt.on(*%w{-h --help}, "Display this help, or help for a specific command")
|
|
|
|
opt.on(*%w{-i -A -q -e -p}, "Forward to nix-env") { sh ["nix-env", *ARGV]; exit }
|
|
|
|
end
|
|
|
|
opts.order!(args, into: @@opts)
|
|
|
|
|
|
|
|
begin
|
|
|
|
args.unshift("help") if @@opts[:help]
|
|
|
|
if args.length == 0
|
|
|
|
puts "Error: No command specified!"
|
|
|
|
puts
|
|
|
|
raise UsageError
|
|
|
|
else
|
|
|
|
call args.first, args.drop(1)
|
|
|
|
end
|
|
|
|
rescue UsageError
|
|
|
|
puts opts
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2020-10-01 15:46:04 -07:00
|
|
|
|
2021-02-13 09:19:03 -08:00
|
|
|
Hey.run ARGV.dup
|