@everydaydevopsio/ballast 3.0.0 → 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -13,6 +13,17 @@ CLI to install TypeScript AI agent rules for **Cursor**, **Claude Code**, and **
13
13
  | **cicd** | CI/CD pipelines, quality gates, deployment (placeholder outline) |
14
14
  | **observability** | Logging, tracing, metrics, SLOs (placeholder outline) |
15
15
 
16
+ ## Using the agents
17
+
18
+ Once installed, rule files are loaded automatically by your AI platform (Cursor, Claude Code, or OpenCode). Use an agent by asking the AI for help in that area; the rule gives it the instructions.
19
+
20
+ | Agent | How to use it |
21
+ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
22
+ | **linting** | In any session: _"Help me set up linting for this project"_ or _"Fix lint errors per the linting rules."_ The agent will add ESLint, Prettier, Husky, lint-staged, and CI workflows. |
23
+ | **local-dev** | Ask for help with local dev environment, DX, or documentation (placeholder). |
24
+ | **cicd** | Ask for help with CI/CD pipelines, quality gates, or deployment (placeholder). |
25
+ | **observability** | Ask for help with logging, tracing, metrics, or SLOs (placeholder). |
26
+
16
27
  ## Installation
17
28
 
18
29
  Install as a dev dependency in your project:
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@everydaydevopsio/ballast",
3
- "version": "3.0.0",
3
+ "version": "3.0.4",
4
4
  "description": "CLI to install TypeScript AI agent rules (linting, local-dev, CI/CD, observability) for Cursor, Claude Code, and OpenCode",
5
5
  "main": "dist/cli.js",
6
6
  "bin": {
7
- "ballast": "./bin/ballast.js"
7
+ "ballast": "bin/ballast.js"
8
8
  },
9
9
  "files": [
10
10
  "bin",
@@ -15,11 +15,11 @@
15
15
  "license": "MIT",
16
16
  "repository": {
17
17
  "type": "git",
18
- "url": "git+https://github.com/everydaydevopsio/typescript-linting-agent.git"
18
+ "url": "git+https://github.com/everydaydevopsio/ballast.git"
19
19
  },
20
- "homepage": "https://github.com/everydaydevopsio/typescript-linting-agent#readme",
20
+ "homepage": "https://github.com/everydaydevopsio/ballast#readme",
21
21
  "bugs": {
22
- "url": "https://github.com/everydaydevopsio/typescript-linting-agent/issues"
22
+ "url": "https://github.com/everydaydevopsio/ballast/issues"
23
23
  },
24
24
  "devDependencies": {
25
25
  "@eslint/js": "^9.39.2",