Adolfo Reyna
69 lines
5.3 KiB
JavaScript
69 lines
5.3 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.printHelp = void 0;
|
|
const browser_1 = require("./browser");
|
|
const chalk_1 = require("./chalk");
|
|
const gpu_1 = require("./gpu");
|
|
const log_1 = require("./log");
|
|
const versions_1 = require("./versions");
|
|
const packagejson = require('../package.json');
|
|
const printHelp = (logLevel) => {
|
|
log_1.Log.info({ indent: false, logLevel }, `@remotion/cli ${packagejson.version}`);
|
|
log_1.Log.info({ indent: false, logLevel }, `© ${new Date().getFullYear()} Remotion AG`);
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, 'Available commands:');
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion studio') + chalk_1.chalk.gray(' <entry-point.ts>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Start the Remotion studio.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/studio'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion render') +
|
|
chalk_1.chalk.gray(' <entry-point.ts> <comp-id> <output-file.mp4>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Render video, audio or an image sequence.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/render'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion still') +
|
|
chalk_1.chalk.gray(' <entry-point.ts> <comp-id> <still.png>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Render a still frame and save it as an image.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/still'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion bundle') + chalk_1.chalk.gray(' <entry-point.ts>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Create a Remotion bundle to be deployed to the web.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/bundle'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion compositions') + chalk_1.chalk.gray(' <index-file.ts>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Prints the available compositions.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/compositions'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion benchmark') +
|
|
chalk_1.chalk.gray(' <index-file.ts> <list-of-compositions>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Benchmarks rendering a composition. Same options as for render.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/benchmark'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion ' + versions_1.VERSIONS_COMMAND));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Prints and validates versions of all Remotion packages.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/versions'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion ' + gpu_1.GPU_COMMAND));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Prints information about how Chrome uses the CPU.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/gpu'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion upgrade'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Ensure Remotion is on the newest version.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/upgrade'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion add') + chalk_1.chalk.gray(' <package-name...>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Add Remotion packages with the correct version.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/add'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue('remotion skills ') + chalk_1.chalk.gray('<add | update>'));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Install or update skills from remotion-dev/skills.');
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.blue(`remotion ${browser_1.BROWSER_COMMAND}`));
|
|
log_1.Log.info({ indent: false, logLevel }, 'Ensure Remotion has a browser it can use for rendering.');
|
|
log_1.Log.info({ indent: false, logLevel }, chalk_1.chalk.gray('https://www.remotion.dev/docs/cli/browser'));
|
|
log_1.Log.info({ indent: false, logLevel });
|
|
log_1.Log.info({ indent: false, logLevel }, 'Visit https://www.remotion.dev/docs/cli for browsable CLI documentation.');
|
|
};
|
|
exports.printHelp = printHelp;
|