Skip to content

Commit 1244f7d

Browse files
committed
docs: add docs for the cli specifically
1 parent fe902b2 commit 1244f7d

File tree

5 files changed

+71
-0
lines changed

5 files changed

+71
-0
lines changed

.changeset/green-wasps-follow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"docs": minor
3+
---
4+
5+
docs: add docs for the cli specifically

packages/docs/docs/cli/enable.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_label: 'Enable'
3+
displayed_sidebar: webtoolsSidebar
4+
slug: /cli/enable
5+
---
6+
7+
# Enable
8+
9+
## Overview
10+
11+
This command let's you interactively enable Webtools for your content types. It's essentially a programmatic interface for the docs as written on [the Usage docs](/usage).
12+
13+
## Usage
14+
15+
```
16+
npx webtools-cli enable
17+
```

packages/docs/docs/cli/install.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
sidebar_label: 'Install'
3+
displayed_sidebar: webtoolsSidebar
4+
slug: /cli/install
5+
---
6+
7+
# Install
8+
9+
## Overview
10+
11+
The install command is used when you're first installing Webtools in your Strapi project. It helps you to setup your license, enable Webtools for your content types, and select the addons you want to install.
12+
13+
## Usage
14+
15+
```
16+
npx webtools-cli install
17+
```
18+
19+
Apart from installing the packages, the functions of this command can also be ran separately.
20+
21+
1. [The `enable` command](/cli/enable)
22+
2. [The `setup-license` command](/cli/setup-license)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_label: 'Setup License'
3+
displayed_sidebar: webtoolsSidebar
4+
slug: /cli/setup-license
5+
---
6+
7+
# Setup license
8+
9+
## Overview
10+
11+
If you've purchased a license for the premium features of Webtools you can use this CLI to setup the configuration for proper installation and license validation. The CLI will ask you to input your license key which will be added to the `.npmrc` and `.env` files.
12+
13+
## Usage
14+
15+
```
16+
npx webtools-cli setup-license
17+
```

packages/docs/sidebars.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ const sidebars = {
3939
"api/graphql",
4040
],
4141
},
42+
{
43+
type: "category",
44+
collapsed: false,
45+
label: "📟 CLI",
46+
items: [
47+
"cli/install",
48+
"cli/enable",
49+
"cli/setup-license",
50+
],
51+
},
4252
{
4353
type: "category",
4454
collapsed: false,

0 commit comments

Comments
 (0)