Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #425

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ There are three steps to integrating with third party services: _configuration_
1. Install the Mastra CLI:

```bash
npm install -g @mastra/cli
npm install -g mastra
```

2. Initialize your project:

```bash
npx @mastra init
mastra init
```

3. Follow the prompts to set up your database and other configurations.
Expand All @@ -50,7 +50,7 @@ You can find the full list of configuration options in the [Mastra config docs](

### Step 1: Connect through the admin panel

We recommend using the admin panel to set up your first integration. You can run admin panel locally by running `npx @mastra/cli dev` from the root of your project.
We recommend using the admin panel to set up your first integration. You can run admin panel locally by running `mastra dev` from the root of your project.

Note that to integrate with many SaaS platforms, in order to obtain API keys, you will need to set up a console app on their respective websites. We link to these docs from each integration's page in the admin panel.

Expand Down
10 changes: 5 additions & 5 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
## Installation

`npm install -g kpl`
`npm install -g mastra`

## Commands:

`kpl init`
`mastra init`

Initializes a new project.

Run this from the root of the Next.js app you want to add Mastra to. This will create a `mastra.config.ts` file in the root of your project, a `docker-compose.yml` file in the root of your project, and a `.env` file in the root of your project.

`kpl admin`
`mastra admin`

Starts the admin server

`kpl generate`
`mastra generate`

Generates types

`kpl migrate`
`mastra migrate`

Migrate the mastra database forward
Loading