Skip to content

docs: add CI badge, Marketplace badge, and GitHub Action usage section #2

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.

Sign up for GitHub

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

Merged
vamshidhar199 merged 1 commit into from
Apr 13, 2026
Merged

docs: add CI badge, Marketplace badge, and GitHub Action usage section #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 36 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

[![npm version](https://img.shields.io/npm/v/@ctxlint/ctxlint)](https://www.npmjs.com/package/@ctxlint/ctxlint)
[![npm downloads](https://img.shields.io/npm/dt/@ctxlint/ctxlint)](https://www.npmjs.com/package/@ctxlint/ctxlint)
[![CI](https://github.com/ctxlint/Ctxlint/actions/workflows/ci.yml/badge.svg)](https://github.com/ctxlint/Ctxlint/actions/workflows/ci.yml)
[![license](https://img.shields.io/npm/l/@ctxlint/ctxlint)](./LICENSE)
[![dependencies: 1](https://img.shields.io/badge/dependencies-1-brightgreen)](./package.json)
[![tests: 118 passing](https://img.shields.io/badge/tests-118%20passing-brightgreen)](#)
[![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Marketplace-ctxlint-blue?logo=github)](https://github.com/marketplace/actions/ctxlint)

**The linter for AI agent context files and MCP configs.**

Expand Down Expand Up @@ -272,7 +274,7 @@ CLI flags always take precedence over `.ctxlintrc` settings.

## CI integration

### GitHub Actions — basic
### GitHub Actions — Marketplace action (recommended)

```yaml
name: Lint context file
Expand All @@ -283,13 +285,42 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- uses: ctxlint/ctxlint-action@v1
```

Fail on warnings too:

```yaml
- uses: ctxlint/ctxlint-action@v1
with:
node-version: '20'
- run: npx @ctxlint/ctxlint check --severity warn
- run: npx @ctxlint/ctxlint mcp
strict: true
```

Lint a subdirectory (e.g. in a monorepo):

```yaml
- uses: ctxlint/ctxlint-action@v1
with:
path: ./packages/my-agent
```

**Inputs**

| Input | Default | Description |
|-------|---------|-------------|
| `path` | `.` | Project directory to scan |
| `strict` | `false` | Exit 1 on warnings in addition to errors |
| `fail-on-warnings` | `false` | Alias for `strict` |

**Outputs**

| Output | Description |
|--------|-------------|
| `issues-found` | Total number of issues detected |
| `exit-code` | Raw exit code returned by ctxlint |

---

### GitHub Actions — with Code Scanning (SARIF)

```yaml
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ctxlint/ctxlint",
"version": "1.1.1",
"version": "1.1.2",
"description": "Lint your AGENTS.md, CLAUDE.md, and AI agent context files. Catch stale refs, dead commands, and token waste.",
"type": "module",
"bin": {
Expand Down
Loading