getaura 0.1.10 → 0.3.0
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.
- package/LICENSE +126 -0
- package/README.md +12 -4
- package/THIRD-PARTY-NOTICES.md +31 -0
- package/dist/index.js +11970 -2565
- package/dist/index.js.map +1 -1
- package/package.json +6 -3
- package/plugin/skills/{scan → check}/SKILL.md +3 -3
- package/plugin/skills/fix/SKILL.md +4 -2
- package/plugin/skills/next/SKILL.md +4 -2
- package/plugin/skills/setup/SKILL.md +1 -1
- package/templates/LICENSE +16 -0
- package/templates/README.md +7 -3
- package/templates/github/workflows/aura-weekly.yml +2 -2
- package/templates/github/workflows/aura.yml +16 -8
- package/templates/github/workflows/ci.yml +2 -2
- package/templates/guides/add-aura-key-to-github.md +4 -4
- package/templates/guides/ai-spend-limits.md +50 -0
- package/templates/guides/database-backups.md +61 -0
- package/templates/guides/github-security.md +2 -2
- package/templates/guides/install-github-cli.md +1 -1
- package/templates/guides/rotate-generic-key.md +1 -1
- package/templates/guides/sync-migrations.md +88 -0
- package/templates/guides/sync-vercel-env.md +56 -0
- package/templates/nextjs/error.tsx +23 -0
- package/templates/nextjs/global-error.tsx +27 -0
- package/templates/nextjs/not-found.tsx +15 -0
- package/templates/pr/add-error-pages.md +23 -0
- package/templates/pr/protect-agent-secrets.md +18 -0
- package/templates/rules/agent-rules.md +6 -1
- package/templates/skills/aura/SKILL.md +18 -8
- package/templates/skills/error-handling/SKILL.md +2 -0
- package/templates/skills/folder-structure/SKILL.md +2 -1
- package/templates/skills/pre-launch-checklist/SKILL.md +2 -2
- package/templates/skills/secrets-and-env/SKILL.md +1 -1
- package/templates/skills/secure-api-routes/SKILL.md +5 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# License
|
|
2
|
+
|
|
3
|
+
Copyright 2026 John Fazio
|
|
4
|
+
|
|
5
|
+
Parts of this package are licensed differently:
|
|
6
|
+
|
|
7
|
+
- **What Aura writes into your project** is yours. The files in `templates/` and `plugin/`, and any file or
|
|
8
|
+
text Aura generates for your repository (skills, agent rules, commands, workflows, configs, guides, docs),
|
|
9
|
+
are licensed under the MIT No Attribution license (MIT-0) in `templates/LICENSE`. You can use, change and
|
|
10
|
+
share your copies without restriction or attribution.
|
|
11
|
+
- **Third-party code** bundled into `dist/` keeps its own license; see `THIRD-PARTY-NOTICES.md`.
|
|
12
|
+
- **Everything else** in this package is licensed under the Functional Source License, Version 1.1,
|
|
13
|
+
MIT Future License, below.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Functional Source License, Version 1.1, MIT Future License
|
|
18
|
+
|
|
19
|
+
## Abbreviation
|
|
20
|
+
|
|
21
|
+
FSL-1.1-MIT
|
|
22
|
+
|
|
23
|
+
## Notice
|
|
24
|
+
|
|
25
|
+
Copyright 2026 John Fazio
|
|
26
|
+
|
|
27
|
+
## Terms and Conditions
|
|
28
|
+
|
|
29
|
+
### Licensor ("We")
|
|
30
|
+
|
|
31
|
+
The party offering the Software under these Terms and Conditions.
|
|
32
|
+
|
|
33
|
+
### The Software
|
|
34
|
+
|
|
35
|
+
The "Software" is each version of the software that we make available under
|
|
36
|
+
these Terms and Conditions, as indicated by our inclusion of these Terms and
|
|
37
|
+
Conditions with the Software.
|
|
38
|
+
|
|
39
|
+
### License Grant
|
|
40
|
+
|
|
41
|
+
Subject to your compliance with this License Grant and the Patents,
|
|
42
|
+
Redistribution and Trademark clauses below, we hereby grant you the right to
|
|
43
|
+
use, copy, modify, create derivative works, publicly perform, publicly display
|
|
44
|
+
and redistribute the Software for any Permitted Purpose identified below.
|
|
45
|
+
|
|
46
|
+
### Permitted Purpose
|
|
47
|
+
|
|
48
|
+
A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
|
|
49
|
+
means making the Software available to others in a commercial product or
|
|
50
|
+
service that:
|
|
51
|
+
|
|
52
|
+
1. substitutes for the Software;
|
|
53
|
+
|
|
54
|
+
2. substitutes for any other product or service we offer using the Software
|
|
55
|
+
that exists as of the date we make the Software available; or
|
|
56
|
+
|
|
57
|
+
3. offers the same or substantially similar functionality as the Software.
|
|
58
|
+
|
|
59
|
+
Permitted Purposes specifically include using the Software:
|
|
60
|
+
|
|
61
|
+
1. for your internal use and access;
|
|
62
|
+
|
|
63
|
+
2. for non-commercial education;
|
|
64
|
+
|
|
65
|
+
3. for non-commercial research; and
|
|
66
|
+
|
|
67
|
+
4. in connection with professional services that you provide to a licensee
|
|
68
|
+
using the Software in accordance with these Terms and Conditions.
|
|
69
|
+
|
|
70
|
+
### Patents
|
|
71
|
+
|
|
72
|
+
To the extent your use for a Permitted Purpose would necessarily infringe our
|
|
73
|
+
patents, the license grant above includes a license under our patents. If you
|
|
74
|
+
make a claim against any party that the Software infringes or contributes to
|
|
75
|
+
the infringement of any patent, then your patent license to the Software ends
|
|
76
|
+
immediately.
|
|
77
|
+
|
|
78
|
+
### Redistribution
|
|
79
|
+
|
|
80
|
+
The Terms and Conditions apply to all copies, modifications and derivatives of
|
|
81
|
+
the Software.
|
|
82
|
+
|
|
83
|
+
If you redistribute any copies, modifications or derivatives of the Software,
|
|
84
|
+
you must include a copy of or a link to these Terms and Conditions and not
|
|
85
|
+
remove any copyright notices provided in or with the Software.
|
|
86
|
+
|
|
87
|
+
### Disclaimer
|
|
88
|
+
|
|
89
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
|
|
90
|
+
IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
|
|
91
|
+
PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
|
|
92
|
+
|
|
93
|
+
IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
|
|
94
|
+
SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
|
|
95
|
+
EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
|
|
96
|
+
|
|
97
|
+
### Trademarks
|
|
98
|
+
|
|
99
|
+
Except for displaying the License Details and identifying us as the origin of
|
|
100
|
+
the Software, you have no right under these Terms and Conditions to use our
|
|
101
|
+
trademarks, trade names, service marks or product names.
|
|
102
|
+
|
|
103
|
+
## Grant of Future License
|
|
104
|
+
|
|
105
|
+
We hereby irrevocably grant you an additional license to use the Software under
|
|
106
|
+
the MIT license that is effective on the second anniversary of the date we make
|
|
107
|
+
the Software available. On or after that date, you may use the Software under
|
|
108
|
+
the MIT license, in which case the following will apply:
|
|
109
|
+
|
|
110
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
111
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
112
|
+
the Software without restriction, including without limitation the rights to
|
|
113
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
114
|
+
of the Software, and to permit persons to whom the Software is furnished to do
|
|
115
|
+
so, subject to the following conditions:
|
|
116
|
+
|
|
117
|
+
The above copyright notice and this permission notice shall be included in all
|
|
118
|
+
copies or substantial portions of the Software.
|
|
119
|
+
|
|
120
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
121
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
122
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
123
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
124
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
125
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
126
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -18,18 +18,20 @@ Your agent runs the setup and sends you a link to connect your pilot key in the
|
|
|
18
18
|
npx getaura init
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
`init` checks git and the GitHub CLI, asks which coding agent you use, opens your browser to connect your pilot key, drafts your product brief, installs the Aura skill, offers to install the `aura` command and runs your first scan. After that, run `aura
|
|
21
|
+
`init` checks git and the GitHub CLI, asks which coding agent you use, opens your browser to connect your pilot key, drafts your product brief, installs the Aura skill, stops Claude Code from opening your `.env` files, offers to install the `aura` command and runs your first scan. After that, run `aura check` from any folder. Every Aura command needs your pilot key; on a new computer, `aura login` connects it.
|
|
22
22
|
|
|
23
|
-
To install the `aura` command yourself: `npm install -g getaura`. Without it, use `npx getaura <command>` (for example `npx getaura
|
|
23
|
+
To install the `aura` command yourself: `npm install -g getaura`. Without it, use `npx getaura <command>` (for example `npx getaura check`).
|
|
24
24
|
|
|
25
25
|
## What you get
|
|
26
26
|
|
|
27
27
|
- **An Aura score** from deterministic checks across security, agent setup, foundations and structure, explained in plain language.
|
|
28
|
+
- **Aura knows what you're building.** It works out whether each project in the repo is a web app, website, API, mobile app, CLI, library or extension, and which tools it uses, and shows this under the score. `aura inventory` shows why it thinks so. If it guessed wrong, say so during `aura init` or run `aura config kind <kind>` (in a monorepo, add the folder: `aura config kind web-app apps/web`). The correction is saved in `.aura/config.json`, so commit it.
|
|
29
|
+
- **Your setup**: what each project has in place (database, sign-in, email, error monitoring, rate limiting, tests, CI…) and what a project like it usually needs but is missing, in `aura inventory` and the report. It's advice only and never changes the score, and any tool that does the job counts.
|
|
28
30
|
- **Next steps** in priority order. After a scan (or with `aura next`), tick the ones you want in the terminal and Aura does them.
|
|
29
31
|
- **Fixes as pull requests you approve**: `aura apply foundation` puts your brief, agent rules, skills, CI and env example in place in one PR, and `aura fix <finding>` has Aura's agent make code changes on a branch.
|
|
30
32
|
- **An agent that keeps it that way**: the rules and skills Aura installs teach your coding agent your standards, and GitHub Actions re-scans every push.
|
|
31
33
|
|
|
32
|
-
Ask your coding agent: "Check my Aura score and fix the most serious issue." Or use Aura's commands in it: `/aura:
|
|
34
|
+
Ask your coding agent: "Check my Aura score and fix the most serious issue." Or use Aura's commands in it: `/aura:check` and `/aura:fix` in Claude Code, `/aura-check` in Cursor and Pi, `$aura-check` in Codex.
|
|
33
35
|
|
|
34
36
|
## Privacy
|
|
35
37
|
|
|
@@ -37,4 +39,10 @@ Scanning runs on your machine and your repo is never uploaded. Only short, redac
|
|
|
37
39
|
|
|
38
40
|
## Commands
|
|
39
41
|
|
|
40
|
-
`init`, `
|
|
42
|
+
`init`, `check`, `next`, `apply`, `fix`, `guide`, `inventory`, `history`, `summary`, `login`, `whoami`, `config`, `check-staged`. Run `aura <command> --help` for options.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
Aura is licensed under the [Functional Source License, Version 1.1, MIT Future License](LICENSE) (FSL-1.1-MIT). You can use it for your own projects, your company's and your clients', read its code and change it. What you can't do is offer it, or something built from it, as a product that competes with Aura. Two years after each version is released, that version becomes MIT.
|
|
47
|
+
|
|
48
|
+
Everything Aura writes into your project (skills, agent rules, workflows, configs, guides) is yours, under [MIT-0](templates/LICENSE): use, change and share it freely, no attribution needed. Bundled third-party code keeps its own license ([notices](THIRD-PARTY-NOTICES.md)).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
The `getaura` CLI bundles the following open-source code into `dist/index.js`. Each keeps its own license, reproduced here as it requires.
|
|
4
|
+
|
|
5
|
+
## zod
|
|
6
|
+
|
|
7
|
+
https://github.com/colinhacks/zod
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
MIT License
|
|
11
|
+
|
|
12
|
+
Copyright (c) 2025 Colin McDonnell
|
|
13
|
+
|
|
14
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
15
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
16
|
+
in the Software without restriction, including without limitation the rights
|
|
17
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
18
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
19
|
+
furnished to do so, subject to the following conditions:
|
|
20
|
+
|
|
21
|
+
The above copyright notice and this permission notice shall be included in all
|
|
22
|
+
copies or substantial portions of the Software.
|
|
23
|
+
|
|
24
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
25
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
26
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
27
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
28
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
29
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
30
|
+
SOFTWARE.
|
|
31
|
+
```
|