-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquickstart.html
More file actions
116 lines (113 loc) · 5.84 KB
/
quickstart.html
File metadata and controls
116 lines (113 loc) · 5.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="preload" href="/nipcode-logo.png" as="image" />
<link rel="stylesheet" href="/_next/static/chunks/0pwsw40vfluf4.css" />
<link rel="icon" href="/nipcode-logo.png" type="image/png" />
<title>Quickstart · Nipcode docs</title>
<meta name="description" content="From zero to verified package in 60 seconds." />
<link rel="canonical" href="https://nipcode.xyz/quickstart" />
<script src="/scramble.js" defer></script>
</head>
<body>
<a class="skip-link" href="#main">Skip to content</a>
<header class="topbar" aria-label="Primary">
<a class="brand" aria-label="Nipcode home" href="/">
<span class="nipcode-mark" aria-hidden="true" style="--mark-size: 54px"><img alt="" height="54" src="/nipcode-logo.png" width="54" /></span>
<span class="brand-word" aria-hidden="true">Nipcode</span>
</a>
<div class="brand-socials" aria-label="Nipcode links">
<a class="brand-docs-link" href="/docs">Docs</a>
<a class="brand-login-link" href="/account">Login</a>
<a class="brand-icon-button" href="https://github.com/trynipcode/nipcode" target="_blank" rel="noreferrer" title="GitHub" aria-label="GitHub"><img alt="" height="18" src="/github-logo.svg" width="18"/></a>
<a class="brand-icon-button" href="https://x.com/trynipcode" target="_blank" rel="noreferrer" title="X" aria-label="X"><svg aria-hidden="true" viewBox="0 0 24 24" width="18" height="18"><path d="M18.24 2.25h3.31l-7.23 8.26 8.5 11.24h-6.66l-5.21-6.82-5.97 6.82H1.67l7.73-8.84L1.25 2.25h6.83l4.71 6.23 5.45-6.23Zm-1.16 17.52h1.83L7.08 4.13H5.11l11.97 15.64Z" fill="currentColor"/></svg></a>
</div>
</header>
<main class="docs-shell" id="main">
<aside class="docs-sidebar" aria-label="Documentation">
<a class="docs-sidebar-title" href="/docs">Nipcode docs</a>
<nav class="docs-sidebar-nav">
<div class="docs-sidebar-group">
<p>Get started</p>
<div>
<a href="/docs">Overview</a>
<a class="docs-sidebar-active" aria-current="page" href="/quickstart">Quickstart</a>
</div>
</div>
<div class="docs-sidebar-group">
<p>API</p>
<div>
<a href="/api-access">API reference</a>
<a href="/agents">Agents</a>
<a href="/examples">Examples</a>
</div>
</div>
<div class="docs-sidebar-group">
<p>How it works</p>
<div>
<a href="/sources">Sources</a>
<a href="/trust">Trust model</a>
<a href="/architecture">Architecture</a>
<a href="/security">Security</a>
</div>
</div>
</nav>
</aside>
<article class="docs-main">
<header class="docs-hero">
<p class="docs-eyebrow" data-scramble-text data-scramble-duration="600">Quickstart</p>
<h1>From zero to verified package in 60 seconds.</h1>
<p>Get a free key, ask Nipcode a question, read the verdict, approve the install yourself.</p>
</header>
<section class="docs-section">
<div class="docs-section-head"><h2>1. Get a key</h2></div>
<div class="docs-prose">
<p>Open <a href="/">nipcode.xyz</a>, enter your email, paste the 6-digit code from the sign-in email. Your account dashboard opens at <a href="/account">/account</a> and your primary key appears under <a href="/account/keys">API keys</a>.</p>
<p>The key looks like <code>nip_094cda2070725db12cbf6e8b2d61ef39</code>. Treat it like a password.</p>
</div>
</section>
<section class="docs-section">
<div class="docs-section-head"><h2>2. Ask for a recommendation</h2></div>
<div class="docs-prose">
<pre><code>KEY=nip_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
curl -H "x-nipcode-api-key: $KEY" \
"https://nipcode.xyz/api/decision?q=fast%20xml%20parser&sources=npm&limit=3"</code></pre>
<p>The response includes a <code>best</code> object with a one-line recommendation, decision and trust scores (0-100), a risk level, and an <code>install_boundary</code> with the exact command you would run.</p>
</div>
</section>
<section class="docs-section">
<div class="docs-section-head"><h2>3. Inspect or check a known package</h2></div>
<div class="docs-prose">
<pre><code>curl -H "x-nipcode-api-key: $KEY" \
"https://nipcode.xyz/api/inspect?source=npm&name=undici"
curl -H "x-nipcode-api-key: $KEY" \
"https://nipcode.xyz/api/install-plan?source=npm&name=undici&version=8.3.0"</code></pre>
<p>Inspect refreshes one record with full trust factors. Install-plan returns just the command and approval boundary for when an agent has already chosen.</p>
</div>
</section>
<section class="docs-section">
<div class="docs-section-head"><h2>4. Approve the install yourself</h2></div>
<div class="docs-prose">
<p>Nipcode never installs anything. Read the <code>install_boundary.command</code>, decide if you trust it, run it locally.</p>
<p>If you are wiring an AI agent, see <a href="/agents">Agents</a>.</p>
</div>
</section>
<section class="docs-next" aria-label="Next">
<a class="docs-card" href="/api-access"><p class="docs-eyebrow" data-scramble-text data-scramble-duration="600">Next</p><h3>API reference</h3><p>Full parameter list, response shapes, error codes.</p></a>
<a class="docs-card" href="/agents"><p class="docs-eyebrow" data-scramble-text data-scramble-duration="600">Or</p><h3>Agents</h3><p>Wire Nipcode into Claude / Cursor / autogen.</p></a>
</section>
</article>
</main>
<footer class="site-footer" aria-label="Site footer">
<p class="site-footer-copy">Nipcode © 2026</p>
<nav class="site-footer-links" aria-label="Legal">
<a href="/changelog">Changelog</a>
<a href="/privacy">Privacy</a>
<a href="/terms">Terms</a>
<a href="/faq">FAQ</a>
</nav>
</footer>
</body>
</html>