Quickstart
After installing f:
f # the index: every uck name, no descriptions
f search <q> # rank ucks against a query (name, then description)
f --version # print the version (core; also `f -V`, or `f v`)
f config get ucks # read f's own config
f is designed to be driven by a program: ucks print terse output and accept
short arguments, no colors, no "Done!".
The default ucks
On first run f seeds its config with the
@fcli.dev/ucks npm package
and installs it into the store. The defaults are:
| Uck | Description |
|---|---|
f v |
print version (f --version / f -V do the same) |
f config |
edit f.config.json via JSONPath |
f creds |
store credentials (encrypted, daemon, TTL) |
f providers |
list credential providers registered with f creds |
f skills |
manage skill files (markdown, read on demand) |
f uck |
push store ucks to a git repo |
up and help are core builtins — special-cased in core before the uck
registry is read, so they work even with an empty store. help is the no-arg
behavior; up re-fetches every configured source (see
Update). Each builtin's subcommands are listed on the
Builtins page.
Add a uck
A uck is a directory with an index.js. The smallest one:
mkdir -p ~/my-ucks/hello
// ~/my-ucks/hello/index.js
export function register(_ctx) {
return {
name: "hello",
desc: "say hello",
run: (_argv, args) => {
process.stdout.write(`hello ${args._[0] ?? "world"}\n`);
},
};
}
export default { register };
Point a config source at it, then update:
f config add ucks ./my-ucks # point at the directory containing hello/
f up
f hello kenny