Skip to content

Commit

Permalink
Merge pull request #62 from underctrl-io/master
Browse files Browse the repository at this point in the history
sync next to master
  • Loading branch information
notunderctrl committed Feb 3, 2024
2 parents 32865da + 9582adc commit 0f87e0f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
2 changes: 1 addition & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "commandkit-docs",
"name": "docs",
"version": "0.0.0",
"private": true,
"scripts": {
Expand Down
18 changes: 17 additions & 1 deletion apps/docs/pages/guide/create-commandkit.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components';

# create-commandkit

Besides installing CommandKit to your existing project, you can also start a new one with `create-commandkit` — a command-line utility used for creating new discord.js bots with CommandKit.
Expand All @@ -12,14 +14,28 @@ npm create commandkit@latest

This will start the CLI in the current directory.

### Development version

Similar to the main package, you could try the `dev` or `next` versions of create-commandkit:

<Callout type="warning">
The development version is likely to have bugs.
</Callout>

```sh copy
npm create commandkit@dev
```

## Prompts

When running create-commandkit, you should be asked the following questions:

- **Project Directory:** Defines where your project will be located. It defaults to the current working directory.
- **Directory:** Defines where your project will be located. It defaults to the current working directory.

- **Package Manager:** Lets you choose which package manager to use — npm, pnpm, or Yarn.

- **Language ([Development version](/guide/installation#development-version) only):** The language to use for your project — JavaScript or TypeScript.

- **Module Type:** Allows you to pick between CommonJS (using require and module.exports), and ESM (using import and export).

- **Bot Token:** Asks you for your bot token, and writes it into the `.env` file where it will be stored.
Expand Down

0 comments on commit 0f87e0f

Please sign in to comment.