Skip to content

Development environment setup - #340

Open
XavierW10 wants to merge 2 commits into
mainfrom
cursor/development-environment-setup-2bd1
Open

XavierW10 wants to merge 2 commits into
mainfrom
cursor/development-environment-setup-2bd1

Conversation

@XavierW10

Copy link
Copy Markdown
Contributor

Add AGENTS.md with development environment setup instructions.

Open in Web Open in Cursor 

Co-authored-by: Xavier Warmerdam <xavwar1@gmail.com>
@cursor

cursor Bot commented Mar 11, 2026

Copy link
Copy Markdown

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@greptile-apps

greptile-apps Bot commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds an AGENTS.md file providing development environment setup instructions for Cursor Cloud agents. The document is concise and covers the key Fern CLI commands, port behavior, and token requirements. One factual error was found: the stated Fern CLI version (4.18.0) does not match the actual pinned version in fern/fern.config.json (4.38.0), which could confuse developers or agents following the guide.

Confidence Score: 4/5

  • Safe to merge after correcting the pinned version number in the caveats section.
  • The change is purely documentation with no runtime impact. A single concrete factual error (wrong version string) should be fixed before merging to avoid misleading contributors.
  • AGENTS.md — version number needs correction on line 21.

Important Files Changed

Filename Overview
AGENTS.md New setup guide for Cursor Cloud agents. Contains one factual error: the pinned Fern CLI version is listed as 4.18.0 but fern/fern.config.json specifies 4.38.0.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: AGENTS.md
Line: 21

Comment:
**Incorrect version number**

The pinned version stated here (`4.18.0`) does not match the actual value in `fern/fern.config.json`, which is currently `4.38.0`. A developer following this guide who manually checks the config file will see a different version, which could cause confusion.

```suggestion
- The Fern CLI version is pinned in `fern/fern.config.json` (`"version": "4.38.0"`). Running `npm install -g fern-api` installs whatever version is specified there.
```

How can I resolve this? If you propose a fix, please make it concise.

Reviews (2): Last reviewed commit: "Merge branch 'main' into cursor/developm..." | Re-trigger Greptile

Comment thread AGENTS.md
- `fern docs dev` starts a backend on port 3001 and a frontend on port 3000. The first startup takes ~20-30 seconds to bootstrap the docs preview bundle.
- `fern check` may report warnings (e.g. about unused types); 0 errors is the passing criterion used in CI.
- Publishing and preview generation require a `FERN_TOKEN` environment variable (not needed for local dev or `fern check`).
- The Fern CLI version is pinned in `fern/fern.config.json` (`"version": "4.18.0"`). Running `npm install -g fern-api` installs whatever version is specified there.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect claim about npm install -g fern-api

The statement "Running npm install -g fern-api installs whatever version is specified there" is inaccurate. npm install -g fern-api always installs the latest version published to the npm registry — it does not read fern/fern.config.json to resolve the pinned version (4.18.0).

A developer following this guide would likely end up with a mismatched CLI version, which can cause subtle incompatibilities at runtime. To install the exact pinned version, the command should explicitly include the version tag:

Suggested change
- The Fern CLI version is pinned in `fern/fern.config.json` (`"version": "4.18.0"`). Running `npm install -g fern-api` installs whatever version is specified there.
- The Fern CLI version is pinned in `fern/fern.config.json` (`"version": "4.18.0"`). To install the exact pinned version, run `npm install -g fern-api@4.18.0`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: AGENTS.md
Line: 21

Comment:
**Incorrect claim about `npm install -g fern-api`**

The statement "Running `npm install -g fern-api` installs whatever version is specified there" is inaccurate. `npm install -g fern-api` always installs the **latest** version published to the npm registry — it does not read `fern/fern.config.json` to resolve the pinned version (`4.18.0`).

A developer following this guide would likely end up with a mismatched CLI version, which can cause subtle incompatibilities at runtime. To install the exact pinned version, the command should explicitly include the version tag:

```suggestion
- The Fern CLI version is pinned in `fern/fern.config.json` (`"version": "4.18.0"`). To install the exact pinned version, run `npm install -g fern-api@4.18.0`.
```

How can I resolve this? If you propose a fix, please make it concise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants