Function printHelp

packages/lambda/src/cli/help.ts:16–86

(logLevel: LogLevel)

const packagejson = require('../../package.json');

export const printHelp = (logLevel: LogLevel) => {
	Log.info(
		{indent: false, logLevel},
		`${BINARY_NAME} ${
			packagejson.version
		} © ${new Date().getFullYear()} The Remotion developers`,
	);
	Log.info({indent: false, logLevel});
	Log.info({indent: false, logLevel}, 'Available commands:');
	Log.info({indent: false, logLevel}, '');

	Log.info(
		{indent: false, logLevel},
		`${BINARY_NAME} ${RENDER_COMMAND} <s3-url> <composition-id>`,
	);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('Render a video in the cloud.'),
	);

	Log.info(
		{indent: false, logLevel},
		`${BINARY_NAME} ${STILL_COMMAND} <s3-url> <composition-id>`,
	);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('Render a still image in the cloud.'),
	);

	Log.info({indent: false, logLevel});
	Log.info({indent: false, logLevel}, `${BINARY_NAME} ${FUNCTIONS_COMMAND}`);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('Deploy and manage AWS Lambda functions.'),
	);

	Log.info({indent: false, logLevel});
	Log.info({indent: false, logLevel}, `${BINARY_NAME} ${SITES_COMMAND}`);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('Deploy and manage Remotion projects.'),
	);

	Log.info({indent: false, logLevel});
	Log.info({indent: false, logLevel}, `${BINARY_NAME} ${COMPOSITIONS_COMMAND}`);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('Print list of composition IDs from a serve URL.'),
	);

	Log.info({indent: false, logLevel});
	Log.info({indent: false, logLevel}, `${BINARY_NAME} ${POLICIES_COMMAND}`);
	Log.info(
		{indent: false, logLevel},
		CliInternals.chalk.gray('View and validate AWS policy files.'),
	);

	Log.info({indent: false, logLevel});