https://raven.nopejs.me/docs/getting-started/Recent content in Getting Started on RavenHugoen-ushttps://raven.nopejs.me/docs/getting-started/installation/Mon, 01 Jan 0001 00:00:00 +0000https://raven.nopejs.me/docs/getting-started/installation/<h1 id="installation"> Installation <a class="anchor" href="#installation">#</a> </h1> <h2 id="requirements"> Requirements <a class="anchor" href="#requirements">#</a> </h2> <table> <thead> <tr> <th>Requirement</th> <th>Version</th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td>Node.js</td> <td>18+</td> <td>Required</td> </tr> <tr> <td>npm</td> <td>bundled with Node</td> <td>Required</td> </tr> <tr> <td>Git</td> <td>any</td> <td>Clone the repository</td> </tr> </tbody> </table> <p>Optional:</p> <ul> <li>Gmail or Microsoft OAuth credentials for <code>raven send</code></li> <li><code>GEMINI_API_KEY</code> for <code>raven draft --gemini</code></li> <li><code>HF_TOKEN</code> (HuggingFace) if openjobdata sync returns HTTP 401</li> </ul> <h2 id="clone-and-setup"> Clone and setup <a class="anchor" href="#clone-and-setup">#</a> </h2> <p>From the Raven repository root:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git clone &lt;your-raven-repo-url&gt; raven </span></span><span style="display:flex;"><span>cd raven </span></span><span style="display:flex;"><span>./raven setup </span></span></code></pre></div><p><code>raven setup</code> runs:</p> <ol> <li><code>npm install</code> in the repo root</li> <li><code>npm install</code> in <code>jobs/</code></li> <li>Creates starter config from examples (if missing):</li> </ol> <table> <thead> <tr> <th>File</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td><code>.env</code></td> <td>Sender identity, API keys, OAuth tokens</td> </tr> <tr> <td><code>config/portals.yml</code></td> <td>Job search filters</td> </tr> <tr> <td><code>config/profile.yml</code></td> <td>Identity, links, resume path</td> </tr> <tr> <td><code>files/resume.md</code></td> <td>Starter resume (replace with yours)</td> </tr> </tbody> </table> <h2 id="install-raven-globally-optional"> Install <code>raven</code> globally (optional) <a class="anchor" href="#install-raven-globally-optional">#</a> </h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>npm link </span></span><span style="display:flex;"><span>raven --help </span></span></code></pre></div><p>Without <code>npm link</code>, use <code>./raven</code> from the repo root.</p>https://raven.nopejs.me/docs/getting-started/quickstart/Mon, 01 Jan 0001 00:00:00 +0000https://raven.nopejs.me/docs/getting-started/quickstart/<h1 id="quick-start"> Quick Start <a class="anchor" href="#quick-start">#</a> </h1> <p>Five minutes from zero to your first tailored application drafts.</p> <h2 id="1-setup"> 1. Setup <a class="anchor" href="#1-setup">#</a> </h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>cd raven </span></span><span style="display:flex;"><span>./raven setup </span></span></code></pre></div><h2 id="2-configure-filters-and-profile"> 2. Configure filters and profile <a class="anchor" href="#2-configure-filters-and-profile">#</a> </h2> <p>Edit <strong><code>config/portals.yml</code></strong> — what jobs to find:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">title_filter</span>: </span></span><span style="display:flex;"><span> <span style="color:#f92672">positive</span>: </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;software engineer&#34;</span> </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;backend&#34;</span> </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;developer&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">negative</span>: </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;nurse&#34;</span> </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;sales&#34;</span> </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#f92672">location_filter</span>: </span></span><span style="display:flex;"><span> <span style="color:#f92672">allow</span>: </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;Remote&#34;</span> </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;India&#34;</span> </span></span></code></pre></div><p>Edit <strong><code>config/profile.yml</code></strong> — who you are when drafting:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">identity</span>: </span></span><span style="display:flex;"><span> <span style="color:#f92672">name</span>: <span style="color:#e6db74">&#34;Your Name&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">email</span>: <span style="color:#e6db74">&#34;you@example.com&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">location</span>: <span style="color:#e6db74">&#34;City, Country&#34;</span> </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#f92672">links</span>: </span></span><span style="display:flex;"><span> <span style="color:#f92672">resume</span>: <span style="color:#e6db74">&#34;files/resume.md&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">portfolio</span>: <span style="color:#e6db74">&#34;https://yoursite.dev&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">github</span>: <span style="color:#e6db74">&#34;https://github.com/you&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#f92672">linkedin</span>: <span style="color:#e6db74">&#34;https://linkedin.com/in/you&#34;</span> </span></span></code></pre></div><p>Replace <strong><code>files/resume.md</code></strong> with your real resume (Markdown with <code>## Experience</code> and <code>-</code> bullets works best).</p>https://raven.nopejs.me/docs/getting-started/dry-run/Mon, 01 Jan 0001 00:00:00 +0000https://raven.nopejs.me/docs/getting-started/dry-run/<h1 id="example-dry-run"> Example Dry Run <a class="anchor" href="#example-dry-run">#</a> </h1> <p>Complete pipeline walkthrough <strong>without sending email</strong>. Copy commands from your Raven repo root.</p> <h2 id="step-0--install"> Step 0 — Install <a class="anchor" href="#step-0--install">#</a> </h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>cd raven </span></span><span style="display:flex;"><span>./raven setup </span></span></code></pre></div><h2 id="step-1--configure"> Step 1 — Configure <a class="anchor" href="#step-1--configure">#</a> </h2> <ol> <li><strong><code>config/profile.yml</code></strong> — name, email, portfolio, GitHub, LinkedIn, resume path</li> <li><strong><code>files/resume.md</code></strong> — your resume with <code>-</code> bullets under <code>## Experience</code></li> <li><strong><code>config/portals.yml</code></strong> — title keywords (e.g. <code>software engineer</code>, <code>backend</code>, <code>developer</code>)</li> </ol> <p>No Gmail OAuth needed for this dry run.</p>