Skip to main content
Home

Built and signed on GitHub Actions

An open-source agent framework for building production-ready agentic AI agents

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
88%
Published
6 days ago (0.4.4)
function getCustomRules
getCustomRules(): Promise<string | null>

Reads custom rules from supported rule files in the current working directory. Searches for rule files in the following order and returns the first one found: .zypherrules, .cursorrules, .windsurfrules, CLAUDE.md, AGENTS.md

Examples

Example 1

const rules = await getCustomRules(); if (rules) { console.log('Found custom rules:', rules); }

Return Type

Promise<string | null>

Contents of the first matching rules file, or null if none found

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";
or

Import directly with a jsr specifier

import { getCustomRules } from "jsr:@corespeed/zypher";

Add Package

pnpm i jsr:@corespeed/zypher
or (using pnpm 10.8 or older)
pnpm dlx jsr add @corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";

Add Package

yarn add jsr:@corespeed/zypher
or (using Yarn 4.8 or older)
yarn dlx jsr add @corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";

Add Package

vlt install jsr:@corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";

Add Package

npx jsr add @corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";

Add Package

bunx jsr add @corespeed/zypher

Import symbol

import { getCustomRules } from "@corespeed/zypher";