@mithran-hq/aegis 0.9.4 → 0.9.6

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 (3) hide show
  1. package/LICENSE +18 -0
  2. package/README.md +136 -0
  3. package/package.json +27 -3
package/LICENSE ADDED
@@ -0,0 +1,18 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ https://www.apache.org/licenses/
4
+
5
+ Copyright 2026 Mithran
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ https://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
18
+
package/README.md ADDED
@@ -0,0 +1,136 @@
1
+ # Aegis
2
+
3
+ Aegis is the Mithran CLI for account authentication, agent gateway
4
+ configuration, and Forge deploys. This package is the npm launcher; it runs the
5
+ native `aegis` binary from the matching `@mithran-hq/aegis-darwin-arm64` package.
6
+
7
+ ## Requirements
8
+
9
+ - macOS 15 or later
10
+ - Apple silicon (arm64)
11
+ - Node.js and npm
12
+
13
+ The launcher refuses unsupported platforms and macOS versions before it starts
14
+ the native binary.
15
+
16
+ ## Install
17
+
18
+ Prerelease builds are published under the npm dist-tag `next`:
19
+
20
+ ```bash
21
+ npm install -g @mithran-hq/aegis@next
22
+ ```
23
+
24
+ The release flow writes the `next` tag and preserves an existing `latest` tag;
25
+ it does not promote `latest`. Install a pinned version when you need a fixed
26
+ build:
27
+
28
+ ```bash
29
+ npm install -g @mithran-hq/aegis@0.9.6
30
+ ```
31
+
32
+ Check the installed version:
33
+
34
+ ```bash
35
+ aegis version
36
+ ```
37
+
38
+ ## Sign in
39
+
40
+ ```bash
41
+ aegis auth login
42
+ aegis auth status
43
+ ```
44
+
45
+ `aegis auth login` opens the browser for sign-in and always prints the sign-in
46
+ URL. Pass `--no-browser` to skip the browser launch and open that URL yourself.
47
+ Sign out with `aegis auth logout`.
48
+
49
+ ## Gateway
50
+
51
+ Enable, inspect, or disable the gateway for one supported agent:
52
+
53
+ ```bash
54
+ aegis gateway enable --agent claude
55
+ aegis gateway status --agent claude
56
+ aegis gateway disable --agent claude
57
+ ```
58
+
59
+ Supported agents are `claude` and `codex`. Gateway commands require a bound
60
+ account; run `aegis auth login` first.
61
+
62
+ ## Forge
63
+
64
+ Initialize a Forge app in the current directory, then commit and push it before
65
+ deploying the committed source:
66
+
67
+ ```bash
68
+ mkdir my-app
69
+ cd my-app
70
+ aegis forge init
71
+ git init
72
+ git add mithran.yaml index.html
73
+ git commit -m "Initialize app"
74
+ git remote add origin git@github.com:<owner>/<repo>.git
75
+ git push -u origin HEAD
76
+ aegis forge deploy
77
+ ```
78
+
79
+ `aegis forge init` writes `mithran.yaml` and `index.html`. `aegis forge deploy`
80
+ resolves the committed source from the Git origin and `HEAD`; pass
81
+ `--repo <owner>/<repo>` when the origin is not a GitHub repository, and pass
82
+ `--ref` or `--sha` to select another committed source. Deploy requires a bound
83
+ account.
84
+
85
+ ## Managed Forge skill
86
+
87
+ A normal global user install also installs the `aegis-forge` instruction skill
88
+ for Claude and Codex:
89
+
90
+ - `~/.claude/skills/aegis-forge/SKILL.md`
91
+ - `~/.agents/skills/aegis-forge/SKILL.md`
92
+
93
+ Automatic installation runs only for a normal global user installation. It
94
+ skips when npm runs as root or through sudo, under CI, from a local or
95
+ dependency install, or through npx. A skip is reported and changes no files;
96
+ run `aegis skills install` to install explicitly.
97
+
98
+ If npm installs with scripts disabled, install the skill afterwards:
99
+
100
+ ```bash
101
+ aegis skills install
102
+ ```
103
+
104
+ Check the installed state with `aegis skills status`. Existing files Aegis does
105
+ not own, changed Aegis-owned files and unexpected entries are preserved and
106
+ reported; unsafe paths are not followed. Automatic installation uses the
107
+ standard OS-account homes. A custom agent home is selected only by an explicit
108
+ `aegis skills install --agent-home <path>`.
109
+
110
+ npm has no uninstall hook, so remove the skill before removing the CLI:
111
+
112
+ ```bash
113
+ aegis skills remove
114
+ npm uninstall -g @mithran-hq/aegis
115
+ ```
116
+
117
+ The skill explains `forge init` and deploying committed source. Installing it
118
+ grants no deployment authority: authentication, operator decisions and
119
+ point-of-use authorization still apply.
120
+
121
+ ## Documentation
122
+
123
+ User and developer documentation: https://mithran.ai/docs
124
+
125
+ ## Uninstall
126
+
127
+ ```bash
128
+ npm uninstall -g @mithran-hq/aegis
129
+ ```
130
+
131
+ ## Support and security
132
+
133
+ Questions and bug reports: https://github.com/mithran-hq/aegis/issues
134
+
135
+ Security policy: https://github.com/mithran-hq/aegis/blob/main/SECURITY.md
136
+ Do not include live credentials in a report.
package/package.json CHANGED
@@ -2,19 +2,43 @@
2
2
  "bin": {
3
3
  "aegis": "aegis.mjs"
4
4
  },
5
+ "bugs": {
6
+ "url": "https://github.com/mithran-hq/aegis/issues"
7
+ },
5
8
  "cpu": [
6
9
  "arm64"
7
10
  ],
11
+ "description": "Aegis auth, gateway, and Forge CLI for macOS 15+ Apple silicon",
8
12
  "files": [
9
13
  "package.json",
10
- "aegis.mjs"
14
+ "aegis.mjs",
15
+ "README.md",
16
+ "LICENSE"
17
+ ],
18
+ "homepage": "https://mithran.ai/docs",
19
+ "keywords": [
20
+ "aegis",
21
+ "auth",
22
+ "gateway",
23
+ "forge",
24
+ "cli",
25
+ "macos",
26
+ "arm64"
11
27
  ],
28
+ "license": "Apache-2.0",
12
29
  "name": "@mithran-hq/aegis",
13
30
  "optionalDependencies": {
14
- "@mithran-hq/aegis-darwin-arm64": "0.9.4"
31
+ "@mithran-hq/aegis-darwin-arm64": "0.9.6"
15
32
  },
16
33
  "os": [
17
34
  "darwin"
18
35
  ],
19
- "version": "0.9.4"
36
+ "repository": {
37
+ "type": "git",
38
+ "url": "git+https://github.com/mithran-hq/aegis.git"
39
+ },
40
+ "scripts": {
41
+ "postinstall": "node aegis.mjs skills install --npm-postinstall"
42
+ },
43
+ "version": "0.9.6"
20
44
  }