[{"data":1,"prerenderedAt":582},["ShallowReactive",2],{"navigation":3,"\u002Fcli":228,"\u002Fcli-surround":577},[4,9,14,40,57,74,99,116,137,154,211,220],{"title":5,"path":6,"stem":7,"icon":8},"Quick start","\u002Fgetting-started","01.getting-started","i-lucide-rocket",{"title":10,"path":11,"stem":12,"icon":13},"Set up from the terminal","\u002Fcli","02.cli","i-lucide-terminal",{"title":15,"path":16,"stem":17,"children":18,"page":39},"Domains & DNS","\u002Fdomains","03.domains",[19,23,27,31,35],{"title":20,"path":21,"stem":22},"Adding a domain","\u002Fdomains\u002Fadding-a-domain","03.domains\u002F01.adding-a-domain",{"title":24,"path":25,"stem":26},"Automatic DNS setup","\u002Fdomains\u002Fautomatic-dns-setup","03.domains\u002F02.automatic-dns-setup",{"title":28,"path":29,"stem":30},"Manual DNS records","\u002Fdomains\u002Fmanual-dns-records","03.domains\u002F03.manual-dns-records",{"title":32,"path":33,"stem":34},"Domain verification","\u002Fdomains\u002Fverification","03.domains\u002F04.verification",{"title":36,"path":37,"stem":38},"Troubleshooting DNS","\u002Fdomains\u002Ftroubleshooting","03.domains\u002F05.troubleshooting",false,{"title":41,"path":42,"stem":43,"children":44,"page":39},"Mailboxes & Aliases","\u002Fmailboxes","04.mailboxes",[45,49,53],{"title":46,"path":47,"stem":48},"Creating mailboxes","\u002Fmailboxes\u002Fcreating-mailboxes","04.mailboxes\u002F01.creating-mailboxes",{"title":50,"path":51,"stem":52},"Aliases","\u002Fmailboxes\u002Faliases","04.mailboxes\u002F02.aliases",{"title":54,"path":55,"stem":56},"Passwords, passkeys & access","\u002Fmailboxes\u002Fpasswords-and-access","04.mailboxes\u002F03.passwords-and-access",{"title":58,"path":59,"stem":60,"children":61,"page":39},"Using Your Mail","\u002Fmail","05.mail",[62,66,70],{"title":63,"path":64,"stem":65},"Webmail","\u002Fmail\u002Fwebmail","05.mail\u002F01.webmail",{"title":67,"path":68,"stem":69},"IMAP & SMTP settings","\u002Fmail\u002Fimap-smtp-settings","05.mail\u002F02.imap-smtp-settings",{"title":71,"path":72,"stem":73},"iPhone setup","\u002Fmail\u002Fios-profile","05.mail\u002F03.ios-profile",{"title":75,"path":76,"stem":77,"children":78,"page":39},"Drive","\u002Fdrive","06.drive",[79,83,87,91,95],{"title":80,"path":81,"stem":82},"Drive overview","\u002Fdrive\u002Foverview","06.drive\u002F01.overview",{"title":84,"path":85,"stem":86},"Uploading & organising files","\u002Fdrive\u002Ffiles-and-folders","06.drive\u002F02.files-and-folders",{"title":88,"path":89,"stem":90},"Sharing files","\u002Fdrive\u002Fsharing","06.drive\u002F03.sharing",{"title":92,"path":93,"stem":94},"Connect Drive to other apps","\u002Fdrive\u002Fconnect-apps","06.drive\u002F04.connect-apps",{"title":96,"path":97,"stem":98},"Desktop app","\u002Fdrive\u002Fdesktop-app","06.drive\u002F05.desktop-app",{"title":100,"path":101,"stem":102,"children":103,"page":39},"Sending & Campaigns","\u002Fsending","07.sending",[104,108,112],{"title":105,"path":106,"stem":107},"Sending limits","\u002Fsending\u002Flimits","07.sending\u002F01.limits",{"title":109,"path":110,"stem":111},"Campaigns","\u002Fsending\u002Fcampaigns","07.sending\u002F02.campaigns",{"title":113,"path":114,"stem":115},"Deliverability & staying out of spam","\u002Fsending\u002Fdeliverability","07.sending\u002F03.deliverability",{"title":117,"path":118,"stem":119,"children":120,"page":39},"Transactional Email","\u002Ftransactional","08.transactional",[121,125,129,133],{"title":122,"path":123,"stem":124},"Transactional email","\u002Ftransactional\u002Foverview","08.transactional\u002F01.overview",{"title":126,"path":127,"stem":128},"Templates","\u002Ftransactional\u002Ftemplates","08.transactional\u002F02.templates",{"title":130,"path":131,"stem":132},"Sending via the API","\u002Ftransactional\u002Fsend-api","08.transactional\u002F03.send-api",{"title":134,"path":135,"stem":136},"Webhooks","\u002Ftransactional\u002Fwebhooks","08.transactional\u002F04.webhooks",{"title":138,"path":139,"stem":140,"children":141,"page":39},"Migrations","\u002Fmigrations","09.migrations",[142,146,150],{"title":143,"path":144,"stem":145},"Migrating your email","\u002Fmigrations\u002Foverview","09.migrations\u002F01.overview",{"title":147,"path":148,"stem":149},"Migrating from Gmail","\u002Fmigrations\u002Ffrom-gmail","09.migrations\u002F02.from-gmail",{"title":151,"path":152,"stem":153},"Migrating from Microsoft 365","\u002Fmigrations\u002Ffrom-microsoft-365","09.migrations\u002F03.from-microsoft-365",{"title":155,"path":156,"stem":157,"children":158,"page":39},"AI & Developers","\u002Fdevelopers","10.developers",[159,163,167,171,175,178,182,186,191,195,199,203,207],{"title":160,"path":161,"stem":162,"icon":8},"Quickstart","\u002Fdevelopers\u002Fquickstart","10.developers\u002F00.quickstart",{"title":164,"path":165,"stem":166},"Connect ChatGPT","\u002Fdevelopers\u002Fconnect-chatgpt","10.developers\u002F01.connect-chatgpt",{"title":168,"path":169,"stem":170},"Connect Claude","\u002Fdevelopers\u002Fconnect-claude","10.developers\u002F01.connect-claude",{"title":172,"path":173,"stem":174},"AI agents & API keys","\u002Fdevelopers\u002Fai-agents","10.developers\u002F02.ai-agents",{"title":134,"path":176,"stem":177},"\u002Fdevelopers\u002Fwebhooks","10.developers\u002F03.webhooks",{"title":179,"path":180,"stem":181},"Partner API","\u002Fdevelopers\u002Fpartners","10.developers\u002F04.partners",{"title":183,"path":184,"stem":185},"Use Faivelo from your coding agent","\u002Fdevelopers\u002Fcoding-agents","10.developers\u002F06.coding-agents",{"title":187,"path":188,"stem":189,"icon":190},"Errors","\u002Fdevelopers\u002Ferrors","10.developers\u002F07.errors","i-lucide-circle-alert",{"title":192,"path":193,"stem":194},"Email your agent","\u002Fdevelopers\u002Femail-your-agent","10.developers\u002F08.email-your-agent",{"title":196,"path":197,"stem":198},"Email agent with Claude","\u002Fdevelopers\u002Fagent-with-claude","10.developers\u002F09.agent-with-claude",{"title":200,"path":201,"stem":202},"Email agent with ChatGPT","\u002Fdevelopers\u002Fagent-with-chatgpt","10.developers\u002F10.agent-with-chatgpt",{"title":204,"path":205,"stem":206},"Next.js","\u002Fdevelopers\u002Fnextjs","10.developers\u002F11.nextjs",{"title":208,"path":209,"stem":210},"Nuxt","\u002Fdevelopers\u002Fnuxt","10.developers\u002F12.nuxt",{"title":212,"path":213,"stem":214,"children":215,"page":39},"Billing","\u002Fbilling","11.billing",[216],{"title":217,"path":218,"stem":219},"Billing & plans","\u002Fbilling\u002Fplans","11.billing\u002F01.plans",{"title":221,"path":222,"stem":223,"children":224,"page":39},"Security","\u002Fsecurity","12.security",[225],{"title":221,"path":226,"stem":227},"\u002Fsecurity\u002Foverview","12.security\u002F01.overview",{"id":229,"title":10,"body":230,"description":570,"extension":571,"links":572,"meta":573,"navigation":574,"path":11,"seo":575,"stem":12,"__hash__":576},"docs\u002F02.cli.md",{"type":231,"value":232,"toc":563},"minimark",[233,237,266,269,274,377,381,456,460,519,537,541,559],[234,235,236],"p",{},"If you live in a terminal, you can set up email on your domain without touching the dashboard:",[238,239,244],"pre",{"className":240,"code":241,"language":242,"meta":243,"style":243},"language-bash shiki shiki-themes github-light-high-contrast","npx faivelo init yourcompany.com\n","bash","",[245,246,247],"code",{"__ignoreMap":243},[248,249,252,256,260,263],"span",{"class":250,"line":251},"line",1,[248,253,255],{"class":254},"sV4o_","npx",[248,257,259],{"class":258},"sYEJz"," faivelo",[248,261,262],{"class":258}," init",[248,264,265],{"class":258}," yourcompany.com\n",[234,267,268],{},"There is nothing to install. The command signs you in, adds the domain, gets the DNS records in place (automatically where your DNS host allows it), waits until they are live, and creates your first mailbox — then hands you the credentials once.",[270,271,273],"h2",{"id":272},"what-it-does-step-by-step","What it does, step by step",[275,276,277,297,303,309,342,356],"ol",{},[278,279,280,284,285,288,289,292,293,296],"li",{},[281,282,283],"strong",{},"Sign in."," A pairing code appears in the terminal and your browser opens ",[245,286,287],{},"faivelo.com\u002Fcli\u002Fauthorize",". Sign in or create a free account, check the code matches, click ",[281,290,291],{},"Approve",". The terminal notices on its own. Working over SSH? Add ",[245,294,295],{},"--no-open"," and open the printed link from any browser; the code is the same.",[278,298,299,302],{},[281,300,301],{},"Checks the domain."," Nameservers, who hosts the DNS, whether the domain already receives mail somewhere (it tells you before anything changes), and whether the domain is registered at all.",[278,304,305,308],{},[281,306,307],{},"Adds the domain"," to your account and generates the records.",[278,310,311,314,315],{},[281,312,313],{},"Gets the records in",", choosing the easiest path your host supports:\n",[316,317,318,324,330,336],"ul",{},[278,319,320,323],{},[281,321,322],{},"Connect in your browser"," — Cloudflare, Vercel, Netlify, DigitalOcean, WordPress.com, Google Cloud DNS: one consent screen, no keys.",[278,325,326,329],{},[281,327,328],{},"Approve at your host"," — hosts that support Domain Connect add the records for you.",[278,331,332,335],{},[281,333,334],{},"Paste an API key"," — GoDaddy, Namecheap, Route 53, Hostinger, Porkbun, name.com, Gandi, IONOS and more. The terminal tells you exactly where the key page is and what format it expects.",[278,337,338,341],{},[281,339,340],{},"By hand"," — full, copy-ready values shaped for your host's form (Squarespace, Shopify and Bluehost quirks included), while the terminal keeps checking every 10 seconds.",[278,343,344,347,348,351,352,355],{},[281,345,346],{},"Waits for DNS."," Live progress like ",[245,349,350],{},"4\u002F9 required records found",". Stop anytime with Ctrl+C; ",[245,353,354],{},"npx faivelo status yourcompany.com"," picks up where you left off.",[278,357,358,361,362,365,366,369,370,373,374,376],{},[281,359,360],{},"Creates your first mailbox"," and prints the password, IMAP and SMTP settings once. Inside a project folder it offers to write ",[245,363,364],{},"SMTP_*"," and ",[245,367,368],{},"IMAP_*"," into ",[245,371,372],{},".env"," (and warns if ",[245,375,372],{}," isn't gitignored).",[270,378,380],{"id":379},"commands","Commands",[382,383,384,397],"table",{},[385,386,387],"thead",{},[388,389,390,394],"tr",{},[391,392,393],"th",{},"Command",[391,395,396],{},"What it does",[398,399,400,411,421,439],"tbody",{},[388,401,402,408],{},[403,404,405],"td",{},[245,406,407],{},"npx faivelo init [domain]",[403,409,410],{},"The full setup above. Safe to re-run: it resumes wherever the domain is.",[388,412,413,418],{},[403,414,415],{},[245,416,417],{},"npx faivelo status [domain]",[403,419,420],{},"All your domains, or one domain's DNS checked live.",[388,422,423,428],{},[403,424,425],{},[245,426,427],{},"npx faivelo dns \u003Cdomain>",[403,429,430,431,434,435,438],{},"The records to add, with full values. ",[245,432,433],{},"--table"," for a compact view, ",[245,436,437],{},"--zone"," for a BIND zone file you can import.",[388,440,441,453],{},[403,442,443,446,447,446,450],{},[245,444,445],{},"npx faivelo login"," \u002F ",[245,448,449],{},"logout",[245,451,452],{},"whoami",[403,454,455],{},"Manage the sign-in saved on this computer.",[270,457,459],{"id":458},"options","Options",[316,461,462,475,486,496,513],{},[278,463,464,466,467,470,471,474],{},[245,465,295],{}," — never launch a browser, only print links (SSH sessions, containers, CI). It is also automatic when ",[245,468,469],{},"CI"," or ",[245,472,473],{},"SSH_CONNECTION"," is set.",[278,476,477,446,479,481,482,485],{},[245,478,433],{},[245,480,437],{}," — with ",[245,483,484],{},"dns",": a compact table, or a BIND zone file to import.",[278,487,488,491,492,495],{},[245,489,490],{},"--api \u003Curl>"," — talk to another Faivelo instance (or set ",[245,493,494],{},"FAIVELO_API_URL",").",[278,497,498,501,502,505,506,501,509,512],{},[245,499,500],{},"-v",", ",[245,503,504],{},"--version"," — print the CLI version. ",[245,507,508],{},"-h",[245,510,511],{},"--help"," — list commands and options.",[278,514,515,518],{},[245,516,517],{},"FAIVELO_TOKEN"," — skip the browser sign-in entirely by supplying a session token (scripts and CI).",[234,520,521,522,525,526,529,530,533,534,495],{},"Running ",[245,523,524],{},"npx faivelo"," with no command is the same as ",[245,527,528],{},"npx faivelo init",". The CLI ships inside the ",[245,531,532],{},"faivelo"," npm package, which is also the Node.js SDK (",[245,535,536],{},"npm install faivelo",[270,538,540],{"id":539},"where-things-are-stored","Where things are stored",[234,542,543,544,547,548,551,552,555,556,558],{},"The sign-in is saved to ",[245,545,546],{},"~\u002F.config\u002Ffaivelo\u002Fcredentials.json"," (",[245,549,550],{},"%APPDATA%\\faivelo"," on Windows), readable only by your user. ",[245,553,554],{},"npx faivelo logout"," removes it. Mailbox passwords are never stored by the CLI — they are shown once, and optionally written to your project's ",[245,557,372],{}," when you say yes.",[560,561,562],"style",{},"html pre.shiki code .sV4o_, html code.shiki .sV4o_{--shiki-default:#702C00}html pre.shiki code .sYEJz, html code.shiki .sYEJz{--shiki-default:#032563}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":243,"searchDepth":251,"depth":564,"links":565},2,[566,567,568,569],{"id":272,"depth":564,"text":273},{"id":379,"depth":564,"text":380},{"id":458,"depth":564,"text":459},{"id":539,"depth":564,"text":540},"npx faivelo init walks you from a bare domain to a working mailbox without leaving your terminal.","md",null,{},{"icon":13},{"title":10,"description":570},"9n9PsSOzEM0JQVQVfghDCS1m8UqEVyLXmZbh4zJJBzQ",[578,580],{"title":5,"path":6,"stem":7,"description":579,"icon":8,"children":-1},"From signup to a working mailbox in two minutes.",{"title":20,"path":21,"stem":22,"description":581,"children":-1},"Connect a domain you own to Faivelo.",1794152173252]