Connect X1 to your terminal
See your household and ask X1 from the terminal.
Install one command and sign in. x1 shows what X1 holds for your household and answers questions from your own documents, naming the documents behind each answer.
Your household's records live in X1: the trusts, companies, properties and the documents behind them. x1 puts that record in the terminal, where you and the agents you work with can read it without opening a browser.
Set up x1 in four steps.
Two commands. You need an X1 account, and a free one works, even before it holds any documents.
- 01
Install x1
Run npm install -g @x1wealth/cli. You need Node.js 20 or newer. To try it without installing, use npx @x1wealth/cli in place of x1, for example npx @x1wealth/cli login.
- 02
Sign in with X1
Run x1 login. Your browser opens the X1 sign-in. Sign in with the X1 account you want the terminal to work from and approve the access. If this terminal wasn't signed in before, x1 then opens Settings, Connections in your browser (or prints the link), where you choose whether the terminal may see what is waiting on you and your full project details. The terminal can only read until you sign in with x1 login --write.
- 03
Check the connection
Run x1 office. It shows your household and who owns what, plus whatever else your account and your choices in X1 let this terminal see, such as your team, what is waiting on you and what you decided.
- 04
Ask one question you can check
Run x1 ask "What does X1 have on file for our trust?" The answer names the documents it came from, so you can open them and check.
Start with a question you can check.
x1 ask "Who owns the rental property, and which documents show it?"
The answer names the documents behind it, with the page when X1 has one.
x1 work
What is waiting on you, with anything due first, and your saved plans.
In Claude Code or Codex, after x1 skill: “Use x1 to list what's still open before our CPA meeting, with the document behind each item.”
Your agent works from the same household you see in the terminal.
What x1 can do.
- Show your household: who owns what, and each document filed under its owner.
- Answer questions from your documents and name the documents behind each answer.
- With your OK in X1, list what is waiting on you and your saved plans.
- Depending on your account, also show the Ledger, your team and the decisions your household recorded. x1 office says when this connection can't see one of them.
- Give Claude Code or Codex the same view: x1 skill prints a skill that teaches them to use x1.
- With --write, prepare a request, such as filing a document, that X1 asks you to approve on the web or your phone.
x1 reaches only what your X1 account can reach, and it cannot approve anything. X1 asks for your approval when a change needs it.
If a step doesn't work.
- x1: command not found
- npm's folder for global commands isn't on your PATH. Run npm prefix -g and add the bin folder inside it to your PATH (on Windows, that folder itself), or use npx @x1wealth/cli in place of x1.
- x1 says it can't see what's waiting on you or your work list
- X1 asks you before any app reads what is waiting on you or your full project details. Run x1 open settings, find the row for this computer (X1 terminal on your computer's name), turn on What's waiting on you and Full project details then run the command again. If they already show as on, press Allow on that row if it offers one, or try again in a minute.
- x1 says this terminal is not connected
- Run x1 login again and finish the X1 sign-in in your browser. If you had signed in with --write, sign in with x1 login --write again to keep it.
- x1 says a change needs x1 login --write
- Your terminal is signed in read only. Run x1 login --write so x1 can prepare requests. X1 asks for your approval when a change needs it.
Questions about your terminal and X1.
- Can I use a free X1 account?
- Yes. A free X1 account signs in the same way. The terminal can then show your household and documents, answer questions from them, and, with your OK, list what is waiting on you and your saved plans. A free account doesn't include the Ledger, your team or your recorded decisions, and x1 office says so.
- Can I use it in scripts?
- Yes. The commands that show your record take --json, so a script or an agent can read the same answers you see.
- Where is my sign-in kept?
- In ~/.config/x1-terminal/, readable only by your user. x1 logout removes it. To end the connection in X1 as well, open Settings, Connections in X1 and choose Disconnect.
- Can x1 move money or approve things?
- No. x1 doesn't trade or move money, and it can't approve anything. A request it prepares waits for your approval in X1.
- Is this the same connection as Claude or ChatGPT?
- No. Each computer's terminal has its own connection, which you can see and turn off in X1 under Settings, Connections.
Ask your household one question from the terminal.
Install x1, sign in once, and ask one question about your household that you can check against the document.
Using a different assistant? Claude or ChatGPT or Codex or Muse or any other MCP app. Or read how to set up an AI assistant for your family's finances.