Function run

src/codepilot-cli.ts:12–263

()

 * Defines the commands supported by the Codepilot CLI.
 */
export async function run() {
    // prettier-ignore
    const args = await yargs(hideBin(process.argv))
        .scriptName('codepilot')
        .command('$0', 'chat mode', {}, async () => {
            // Ensure index exists and has keys
            const index = new CodeIndex();
            if (!await index.isCreated()) {
                console.log(Colorize.output([
                    `We need to first create an index before you can chat with Codepilot.`,
                    `You'll need to provide an OpenAI API key and a source folder to index.`,
                    `You can create an OpenAI API key at https://platform.openai.com/account/api-keys.`,
                    `A paid account is recommended but OpenAI will give you $5 in free credits to get started.`,
                    `Once you have your OpenAI API key, you can create a new index by running:\n`,
                    `codepilot create --key <api key> --source <source folder> [--source <additional source folder>]\n`,
                    `By default, all files under your source folders will be included in the index.`,
                    `If you'd only like certain file extensions to be indexed, you can add the "--extension <included extensions> [--extension <additional extension>]" option.`,
                    `Once the index has finished building, you can start chatting with Codepilot by running:\n`,
                    `codepilot\n`,
                ].join(`\n`)));
                return;
            }
            if (!await index.hasKeys()) {
                console.log(Colorize.output([
                    `A Codepilot index was found but you haven't configured your personal OpenAI key.`,
                    `You'll need to provide an OpenAI API key before you can continue.`,
                    `You can create an OpenAI API key at https://platform.openai.com/account/api-keys.`,
                    `A paid account is recommended but OpenAI will give you $5 in free credits to get started.`,
                    `Once you have your OpenAI API key, you can configure your local index to use that key by running:\n`,
                    `codepilot set --key <api key>\n`,
                    `Once you've configured your personal key, you can start chatting with Codepilot by running:\n`,
                    `codepilot\n`,
                ].join(`\n`)));
                return;
            }

            // Load index
            await index.load();

            // Start a Codepilot chat session
            const codepilot = new Codepilot(index);
            registerFunctions(codepilot);
            await codepilot.chat();
        })
        .command('create', `creates a new code index`, (yargs) => {
            return yargs
                .option('key', {
                    alias: 'k',
                    describe: 'OpenAI API key to use for generating embeddings and querying the model.',
                    type: 'string'
                })
                .option('model', {
                    alias: 'm',
                    describe: 'OpenAI model to use for queries. Defaults to "gpt-3.5-turbo-16k".',
                    type: 'string',
                    default: 'gpt-3.5-turbo-16k'
                })
                .option('source', {