Quickstart
Install the CLI and preview one asset on your machine.
Create a TypeScript pipeline with the npm CLI. You need Node.js 26 or newer, npm, and registry access. This example uses local filesystem storage. It does not need a repository checkout or Postgres.
Install and preview
-
Install the CLI.
npm install -g @puppi/cli@0.2.0 puppi helplists the commands. There is no--versionflag. -
Create a project.
puppi init my-pipeline The command writes
README.md,puppi.config.ts,src/pipeline.ts,bindings.local.json,package.json,tsconfig.json, and.gitignore. The connection isfiles(@puppi/adapter-filesystem).bindings.local.jsonsetsroottoout/files. The assets areexample/peopleandcore/person.package.jsondepends on@puppi/sdkat^0.3.0.@puppi/adapter-filesystem,@puppi/cli, andtypescriptare devDependencies. Existing files stay unless you pass--force.The command then prints
puppi login,puppi deploy,puppi run, andpuppi status. Those commands talk to the hosted engine. The steps below stay on this machine. -
Install the project’s packages.
cd my-pipeline npm install -
Build the bundle and the manifest.
puppi build The build writes
out/bundle.js,out/manifest.json, andpuppi-env.d.ts. The manifest lists sourceexample/peopleand modelcore/person. The model’s dependency isexample/people. -
Preview the source.
puppi try example/people puppi trypreviews one producer on this machine. It readsbindings.local.json. It does not set an environment’s executor, and it writes no materialization.The command prints two rows, Ada and Grace, columns
idandname, and a passing contract check. The last line isRan locally. Nothing was written. Run puppi deploy && puppi run to run on the engine.--limitsets how many rows are printed. The default is 10.
After the preview
The commands printed by puppi init (login, deploy, run, status) talk to the hosted engine at https://app.puppi.dev. This page does not run them. See Deploy and rollback and the CLI reference. To run attempts on a machine you control, see Workers.
The public API refuses local placement with 403 local_not_allowed.