Skip to content

Commit 57e8ca9

Browse files
viktormarinhoviktormarinho
committed
chore(docs): suggest npm create shortcut instead of global CLI install
1 parent ffa2167 commit 57e8ca9

File tree

5 files changed

+19
-73
lines changed

5 files changed

+19
-73
lines changed

‎apps/web/src/components/workflows/list.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ function WorkflowRunsTab() {
291291

292292
function WorkflowEmptyState() {
293293
const [copied, setCopied] = useState(false);
294-
const cliCommand = "npm i -g deco-cli";
294+
const cliCommand = "npm create deco@latest";
295295

296296
const handleCopy = async () => {
297297
await navigator.clipboard.writeText(cliCommand);

‎docs/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ with Astro and Starlight.
2626

2727
### Prerequisites
2828

29-
- Node.js ≥18.0.0
30-
- [Deco CLI](https://deco.chat): `npm i -g deco-cli`
29+
- Node.js ≥22.0.0
3130

3231
### Setup
3332

‎docs/view/src/content/en/getting-started.mdx‎

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,18 @@ Before you begin, make sure you have the following:
2424
Once your environment is ready, follow these steps to create a new deco.chat project:
2525

2626
<StepGroup>
27-
<Step number={1} title="Install the Deco CLI">
27+
<Step number={1} title="Create a project">
2828
Open your terminal and run:
2929

3030
```bash
31-
npm i -g deco-cli
31+
npm create deco@latest
3232
```
3333

34-
This globally installs the deco command. After installation, you can run `deco --help` to verify it's working.
34+
If you're not authenticated, this will your browser so you can log in or create an account,
35+
then initialize a project for you.
3536
</Step>
3637

37-
<Step number={2} title="Log in to deco.chat">
38-
Use `deco login` to authenticate the CLI with your deco.chat account:
39-
40-
```bash
41-
deco login
42-
```
43-
44-
A browser window will prompt you to sign in, and the CLI will store an API token for your session. (If you don't have an account, sign up on the deco.chat website first.)
45-
</Step>
46-
47-
<Step number={3} title="Initialize a new project">
48-
Navigate to the directory where you want your project and run:
49-
50-
```bash
51-
deco create
52-
```
53-
54-
You'll be guided to pick a template (for example, a **React + Tailwind View** template or a minimal server-only template). The CLI will scaffold a project with the recommended structure. It will also prompt you to configure your workspace and app name (or you can run `deco configure` manually to set these).
55-
</Step>
56-
57-
<Step number={4} title="Install dependencies">
38+
<Step number={2} title="Install dependencies">
5839
After scaffolding, `cd` into the project folder. If the project includes a frontend, run:
5940

6041
```bash
@@ -64,7 +45,7 @@ Once your environment is ready, follow these steps to create a new deco.chat pro
6445
(or `pnpm install`) to install Node dependencies for the view.
6546
</Step>
6647

67-
<Step number={5} title="Run the development server">
48+
<Step number={3} title="Run the development server">
6849
Start your app locally with:
6950

7051
```bash

‎docs/view/src/content/en/guides/getting-started.mdx‎

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,15 @@ import { Step } from "../../../components/ui/Step";
1212
Welcome to deco.chat! This guide will help you create your first MCP server with a beautiful documentation site.
1313

1414
<StepGroup>
15-
<Step number={1} title="Install the CLI">
16-
Run the following command to install the deco CLI:
15+
<Step number={1} title="Create a project">
16+
Run the following command to create a project:
1717

1818
```bash
19-
npm i -g deco-cli
19+
npm create deco@latest
2020
```
2121
</Step>
2222

23-
<Step number={2} title="Authenticate">
24-
Log in to your deco.chat account:
25-
26-
```bash
27-
deco login
28-
```
29-
</Step>
30-
31-
<Step number={3} title="Create a new project">
32-
Initialize a new deco.chat app in your current directory:
33-
34-
```bash
35-
deco create
36-
```
37-
38-
This will set up a complete project with both the MCP server and documentation site.
39-
</Step>
40-
41-
<Step number={4} title="Start development">
23+
<Step number={2} title="Start development">
4224
Navigate to your project directory and start the development server:
4325

4426
```bash
@@ -48,7 +30,7 @@ Welcome to deco.chat! This guide will help you create your first MCP server with
4830
This starts both the MCP server and the documentation site with hot reload.
4931
</Step>
5032

51-
<Step number={5} title="Deploy to production">
33+
<Step number={3} title="Deploy to production">
5234
When you're ready to deploy:
5335

5436
```bash

‎docs/view/src/content/pt-br/getting-started.mdx‎

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,31 @@ icon: Play
88

99
Antes de começar, certifique-se de ter o seguinte:
1010

11-
- **Node.js** (v18+ recomendado) – necessário para executar o servidor de desenvolvimento frontend e empacotar assets.
12-
13-
- **deco.chat CLI** – a interface de linha de comando para deco.chat, que você pode instalar via NPM.
14-
15-
- **Conta Cloudflare** – necessária para implantar seu aplicativo (Cloudflare Workers é o runtime).
11+
- **Node.js** (v22+ recomendado) – necessário para executar o servidor de desenvolvimento frontend e empacotar assets.
1612

1713
- **Conhecimento básico de TypeScript** – O projeto é pesado em TypeScript, então familiaridade com TS é importante (se você é novo, veja a documentação oficial do TypeScript para uma introdução).
1814

19-
## Configuração do Projeto com o CLI
20-
2115
Uma vez que seu ambiente esteja pronto, siga estes passos para criar um novo projeto deco.chat:
2216

23-
### 1. Instale o CLI Deco
17+
### 1. Inicialize um novo projeto
2418

2519
Abra seu terminal e execute:
2620

2721
```shell
28-
npm i -g deco-cli
22+
npm create deco@latest
2923
```
3024

3125
ou
3226

3327
```shell
34-
bun i -g deco-cli
28+
bun create deco@latest
3529
```
3630

37-
Isso instala globalmente o comando deco. Após a instalação, você pode executar `deco --help` para verificar se está funcionando.
38-
39-
### 2. Faça login no deco.chat
40-
41-
Use `deco login` para autenticar o CLI com sua conta deco.chat. Uma janela do navegador solicitará que você faça login, e o CLI armazenará um token de API para sua sessão. (Se você não tem uma conta, cadastre-se primeiro no site deco.chat.)
42-
43-
### 3. Inicialize um novo projeto
44-
45-
Navegue até o diretório onde você quer seu projeto e execute `deco init`. Você será guiado para escolher um template (por exemplo, um template **React + Tailwind View** ou um template minimalista apenas para servidor). O CLI irá estruturar um projeto com a estrutura recomendada. Ele também solicitará que você configure seu workspace e nome do aplicativo (ou você pode executar `deco configure` manualmente para definir estes).
46-
47-
### 4. Instale dependências
31+
### 2. Instale dependências
4832

4933
Após a estruturação, `cd` para a pasta do projeto. Se o projeto incluir um frontend, execute `npm install` (ou `pnpm install`) para instalar dependências Node para a visualização.
5034

51-
### 5. Execute o servidor de desenvolvimento
35+
### 3. Execute o servidor de desenvolvimento
5236

5337
Inicie seu aplicativo localmente com:
5438

0 commit comments

Comments
 (0)