help.ts45 lines · main

1	import { banner, blankLine } from '../output.js';
2
3	const HELP = `
4	usage: briven <command> [options]
5
6	commands:
7	setup create a **new** project + S3 + wire this folder
8	connect attach an **existing** project + S3 + wire this folder
9	storage MinIO/S3 for this project (setup | status) — also run by setup/connect
10	init scaffold briven/ folder only (no cloud) — prefer \`setup\`
11	projects project lifecycle: list, create, use, unlink, set-default
12	auth manage Briven Auth (scaffold middleware, configure providers)
13	login store a dashboard api key for a project (manual path)
14	logout forget stored credentials
15	whoami verify stored credentials against the server
16	deploy create a deployment from the current project
17	invoke invoke a deployed function and print the response
18	link associate this directory with a briven project
19	dev watch mode — push schema + functions on change
20	env manage project environment variables
21	logs stream or fetch logs
22	db open studio or psql against the project database
23	export export schema + functions to a json archive
24	import create a deployment from a json archive on the linked project
25	doctor run a health check against the linked api
26	ai generate schema / function / explain code (schema|function|explain)
27
28	lifecycle (convex-style):
29	briven setup my-app # brand-new project + S3 key
30	briven connect p_… # existing project + S3 key
31	briven deploy # or: briven dev
32
33	options:
34	--version, -v print the cli version and exit
35	--help, -h print this help and exit
36
37	docs: https://docs.briven.tech/connect
38	source: https://code.konnos.org/flndrn/briven
39	`;
40
41	export function printHelp(): void {
42	banner('ship typescript backends to your own version-controlled database');
43	blankLine();
44	process.stdout.write(HELP);
45	}