Core Commands
Every command the core module offers, from its declarations, in order of the resource each acts on. Each command's help says the same.
Core
lnk help
Show Link's commands or the help for one command
lnk help [group] [-- <arguments>...] [--json]arguments, after--, list of string: The command within the groupgroup, position 1, string: The command group whose help to read--json, boolean: Print the answer as JSON for other programs
It answers core.report.
lnk uninstall
Uninstall lnk and its modules, stopping what they run.
lnk uninstall [--all] [--delete <delete>] [--json] [--yes]--all, boolean: Also delete every part--delete, list of string: Also delete a named part (repeat, or comma-separated)--json, boolean: Print the answer as JSON for other programs--yes, boolean: Say yes to what it would ask
It answers core.kept.
lnk up
Set up lnk: choose what you want it for, and it installs the modules that needs
lnk up [uses] [--json] [--module <module>] [--source <source>] [--stale]--json, boolean: Print the answer as JSON for other programs--module, list of string: Select source modules by executable name without lnk-; separate names with commas or repeat the flag--source, list of path: Install supported modules from a source workspace with Cargo--stale, boolean: Refresh only installed source modules whose Cargo build differs from the installed executableuses, position 1, list of string: What you want Link for (agents) [default: asks]
It answers core.report.
lnk upgrade
Upgrade lnk and its modules to the latest release (or a specific version)
lnk upgrade [version] [--check] [--json] [--yes]--check, boolean: Report newer releases and advisories, installing nothing. Ordinary interactive commands refresh this guidance in the background--json, boolean: Print the answer as JSON for other programsversion, position 1, string: Version to install, e.g. 0.14.0 [default: the latest release]--yes, boolean: Say yes to what it would ask
It answers core.report.
Folder
lnk folder check
List old atomic-write staging files in your data without deleting them
lnk folder check [--json]It takes --json, boolean: Print the answer as JSON for other programs. It answers core.staging.
lnk folder create
Make a new, empty Link folder at ~/Link, in place of one that's gone
lnk folder create [--json]It takes --json, boolean: Print the answer as JSON for other programs. It answers core.folder.
lnk folder list
List the map: each location, by its ID, and where it is on this machine, starting with the Link folder
lnk folder list [--json]It takes --json, boolean: Print the answer as JSON for other programs. It answers core.map.
lnk folder set
Move a location to a path: its files, when they're there, and its entry in the map, with every location inside it; or point Link at files you moved
lnk folder set <location> <path> [--json]--json, boolean: Print the answer as JSON for other programslocation, position 1, string, required: The location's ID, aslnk folder listshows it: link for the Link folderpath, position 2, path, required: Where it goes, or where you moved it
It answers core.folder.
Issue
lnk issue create
Turn the last failure into a bug report: its fields, scrubbed of what's private, to paste, or filled in on the bug form with --open
lnk issue create [--json] [--open]It takes --json, boolean: Print the answer as JSON for other programs. It takes --open, boolean: Open the bug form in your browser with what fits filled in. It answers core.report.
Module
lnk module add
Add modules: Link's by name, or one from outside Link by --url
lnk module add [modules] [--json] [--signer <signer>] [--url <url>] [--yes]--json, boolean: Print the answer as JSON for other programsmodules, position 1, list of string: Link's modules by name (lnk module list)--signer, string: Trust this signer (ssh-ed25519 ...) rather than the one its release offers--url, list of string: A module from outside Link, by its GitHub URL, https://github.com// (repeat)--yes, boolean: Say yes to what it would ask
It answers core.report.
lnk module list
List Link's modules, which are installed, and those from outside Link (the default)
lnk module list [--json]It takes --json, boolean: Print the answer as JSON for other programs. It answers list of core.module.
lnk module remove
Remove modules, and what needs them
lnk module remove <modules> [--json]It takes --json, boolean: Print the answer as JSON for other programs. It takes modules, position 1, list of string, required: The modules, as lnk module list names them. It answers core.report.
lnk module show
Show where a module comes from and whether it's installed
lnk module show <module> [--json]It takes --json, boolean: Print the answer as JSON for other programs. It takes module, position 1, string, required: The module, as lnk module list names it. It answers core.module.
Variable
lnk variable list
List command environment variable names and descriptions, optionally for one command, without reading their values
lnk variable list [command] [--json]It takes command, position 1, list of string: Command words to inspect, such as agent start; omit to list all command declarations. It takes --json, boolean: Print the answer as JSON for other programs. It answers list of core.variable.