agentsdotmd 1.1.1 → 1.1.2

package/README

@@ -10,7 +10,7 @@ npm install -g agentsdotmd
 ## Usage
 
 ```bash
-agentsdotmd core.md typescript.md pnpm.md react.md sentry.md vitest.md changelog.md docs-writing.md doppler.md cac.md github.md prisma.md react-router.md shadcn.md tailwind.md lucide.md spiceflow.md vercel-ai-sdk.md playwright.md zod.md stripe.md gitchamber.md
+agentsdotmd core.md typescript.md pnpm.md react.md sentry.md vitest.md changelog.md docs-writing.md doppler.md cac.md github.md prisma.md react-router.md shadcn.md tailwind.md lucide.md spiceflow.md vercel-ai-sdk.md playwright.md zod.md stripe.md gitchamber.md fly.md
 ```
 
 This will generate an `AGENTS.md` file with all the coding guidelines concatenated together.

package/bin/agentsdotmd.js

@@ -50,7 +50,10 @@ cli
 
     try {
       const contents = await Promise.all(promises)
-      const content = contents.join('\n') + '\n'
+      const header = `<!-- This file is auto-generated by the agentsdotmd CLI from your package.json script.
+Do not edit this file directly. To add custom instructions, create a local file ./MY_AGENTS.md
+and add it to your agentsdotmd command in package.json. -->\n\n`
+      const content = header + contents.join('\n') + '\n'
       fs.writeFileSync('AGENTS.md', content)
       console.log(`AGENTS.md generated successfully with ${files.length} file(s)`)
     } catch (error) {

package/changelog.md

@@ -1,5 +1,12 @@
 # changelog
 
+## 1.1.2
+
+### Patch Changes
+
+- Header comment in generated AGENTS.md instructing not to edit directly
+- Instructions to create ./MY_AGENTS.md for custom instructions
+
 after you make a change that is noteworthy, add an entry in the CHANGELOG.md file in the root of the package. there are 2 kinds of packages, public and private packages. private packages have a private: true field in package.json, public packages do not and instead have a version field in package.json. public packages are the ones that are published to npm.
 
 If the current package has a version field and it is not private then include the version in the changelog too like in the examples, otherwise use the current date and time.

package/fly.md

@@ -0,0 +1,11 @@
+# fly
+
+fly is a deployment platform. some packages use it to deploy the website. you can find the deployment scripts searching for **/deployment.ts
+
+usually there are 2 fly apps for each package, one staging environment and one production. these are 2 different apps at 2 different urls, you can target the right app usually by using `pnpm fly:preview` or `pnpm fly:prod`. sometimes there is only `pnpm fly` and you can use that instead. These scripts will append the right --app argument to work on the right fly app.
+
+## reading logs
+
+you can read fly apps logs using `pnpm fly:preview logs --no-tail | tail -n 100`
+
+if content is too long write pipe to a .log file and grep that file for what you are searching (like Error for searching for failures).

package/github.md

@@ -2,6 +2,29 @@
 
 you can use the `gh` cli to do operations on github for the current repository. For example: open issues, open PRs, check actions status, read workflow logs, etc.
 
+## creating issues and pull requests
+
+when opening issues and pull requests with gh cli, never use markdown headings or sections. instead just use simple paragraphs, lists and code examples. be as short as possible while remaining clear and using good English.
+
+example:
+
+```bash
+gh issue create --title "Fix login timeout" --body "The login form times out after 5 seconds on slow connections. This affects users on mobile networks.
+
+Steps to reproduce:
+1. Open login page on 3G connection
+2. Enter credentials
+3. Click submit
+
+Expected: Login completes within 30 seconds
+Actual: Request times out after 5 seconds
+
+Error in console:
+\`\`\`bash
+Error: Request timeout at /api/auth/login
+\`\`\`"
+```
+
 ## get current github repo
 
 `git config --get remote.origin.url`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentsdotmd",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "",
   "type": "module",
   "main": "index.js",