wehub-resource-sync
59 lines
1.7 KiB
Plaintext
59 lines
1.7 KiB
Plaintext
---
|
|
title: "CLI setup"
|
|
sidebarTitle: "CLI setup · Recommended"
|
|
description: "Install the InsForge CLI, link a project, and generate types from the terminal in about five minutes to start building against your backend."
|
|
---
|
|
|
|
## Step 1: Create your project
|
|
|
|
<Card title="Go to InsForge Cloud" icon="cloud" href="https://insforge.dev">
|
|
Visit [insforge.dev](https://insforge.dev) and create a free account
|
|
</Card>
|
|
|
|
Once logged in:
|
|
|
|
<Steps>
|
|
<Step title="Create Project">
|
|
Click **"Create New Project"**
|
|
</Step>
|
|
<Step title="Wait for Backend">
|
|
Your backend will be ready in ~3 seconds
|
|
</Step>
|
|
<Step title="Copy Project ID">
|
|
You'll be redirected to the project console — copy the **Project ID** from the browser URL:
|
|
</Step>
|
|
</Steps>
|
|
|
|
```
|
|
https://insforge.dev/dashboard/project/<your-project-id>
|
|
```
|
|
|
|
You'll need this Project ID in Step 2.
|
|
|
|
## Step 2: Link the CLI
|
|
|
|
From your project directory, link your local code to your InsForge project. Replace `<your-project-id>` with the ID from Step 1.
|
|
|
|
```bash
|
|
npx @insforge/cli link --project-id <your-project-id>
|
|
```
|
|
|
|
Running through `npx` keeps the CLI out of your global install path. The link file ends up in the current directory and tells subsequent commands which project they belong to.
|
|
|
|
## Step 3: Verify installation
|
|
|
|
Send the following prompt to your AI coding agent to verify the setup:
|
|
|
|
`I'm using InsForge as my backend platform. Read the current directory, make sure InsForge skills are installed, and use InsForge CLI for backend tasks.`
|
|
|
|
## Learn more
|
|
|
|
To explore the full capabilities of the InsForge CLI:
|
|
|
|
- Check the [npm package documentation](https://www.npmjs.com/package/@insforge/cli)
|
|
- Run the built-in help command:
|
|
|
|
```bash
|
|
npx @insforge/cli --help
|
|
```
|