code README

The project's README from github.com/nikivdev/code. As one markdown file: README.md.

flow

Everything you need to move your project faster

Install

Install the latest release (macOS/Linux):

curl -fsSL https://myflow.sh/install.sh | sh

Then run:

~/.flow/bin/f --version
~/.flow/bin/f doctor

If f is not found by name immediately, open a new shell (exec zsh -l on zsh).

The installer verifies SHA-256 checksums when available. If you are installing a legacy release that doesn't ship checksums.txt, it will warn and continue (GitHub download only). To bypass verification explicitly (not recommended), set FLOW_INSTALL_INSECURE=1.

Upgrade

Upgrade to the latest release:

f upgrade

Upgrade to the latest canary build:

f upgrade --canary

Switch back to stable:

f upgrade --stable

If you fork Flow (or publish releases under a different repo), set:

If you are upgrading to a very old tag that doesn't ship checksums.txt, you can force bypassing checksum verification with FLOW_UPGRADE_INSECURE=1 (not recommended).

Build From Source

Clone Flow, hydrate the pinned vendor snapshot, and install an optimized local build:

git clone https://github.com/nikivdev/flow.git
cd flow
./scripts/vendor/vendor-repo.sh hydrate
FLOW_PROFILE=release ./scripts/deploy.sh
~/bin/f --version

If you want to populate the vendor checkout yourself first, that works too:

git clone https://github.com/nikivdev/flow-vendor.git .vendor/flow-vendor
./scripts/vendor/vendor-repo.sh hydrate

Dev Fast

Typical local loop:

f setup
f test
f deploy

If you want to inspect tasks first:

f tasks list

Features

To see the current CLI surface:

f --help

For deeper docs, read docs/.

Supported Platforms

Release artifacts are built for:

Contributing

Use Flow and AI. For the full command surface, run f --help. For project docs and workflows, read docs/.

Discord X nikiv.dev

code (nikivdev/code)

Searching Database…

21.1K ·GitHub
What is this?Flow is a command-line tool you install as the f command, billed as 'everything you need to move your project faster'; its GitHub topics list it under agents and autonomy.
Is this a command-line tool I run in my terminal?Yes — it's a terminal tool. Installing it puts f, flow, and lin binaries into ~/bin, and f --help prints the full command surface.
Is the install script safe to run, or should I check anything first?The installer verifies SHA-256 checksums when available; legacy releases without checksums.txt only warn and continue, and FLOWINSTALLINSECURE=1 lets you bypass verification (not recommended).
Does it run on Windows, or is it Mac and Linux only?There are no Windows builds: release artifacts are built for macOS (arm64, x86_64) and Linux glibc (arm64, x86_64) only.
What does the dev loop look like if I clone the repo to hack on it?The typical local loop is f setup to check the workspace and toolchain, f test to run the test suite, and f deploy to build and install the local CLI into your path.
Why does building from source pull in a pinned vendor snapshot?For reproducible builds: vendor.lock.toml pins a public vendor repo, and the hydrate script reuses .vendor/flow-vendor when it exists or materializes lib/vendor/ from that exact commit.
What are similar projects?miniforge, lane, flow, rye, zerobrew, bashka, leviathan, omarchy-apple-dev
Creator
nikivdev
Size
5.5 MB
Stars
21.1K
Age
10y
Commits · 90 Days