JoripSpace documentation

Install and connect

Choose the CLI for terminal work or connect MCP in your AI agent. Replace PROJECT with your existing project name.

npm install -g @joripspace/cli@latest
joripspace login
joripspace start PROJECT

codex mcp add joripspace --url https://api.joripspace.com/mcp
codex mcp login joripspace

claude mcp add --transport http joripspace --scope user https://api.joripspace.com/mcp

Quick start

Start in an AI coding agent that can use a terminal and files.

1. Prepare a project

   Open or create a project in Projects. start connects to an existing project.

2. Open your work folder

   Open the folder where the agent will save project code. Use the existing work folder when you already have code.

3. Send the message

   Replace both PROJECT placeholders with your project name and send the message below.

Start the JoripSpace project `PROJECT`.

1. Install or update the official CLI with `npm install -g @joripspace/cli@latest`. Even if already installed, compare the npm latest version with the actual executable version. If an older version still runs after updating, resolve and use the latest npm CLI entrypoint.
2. Run `joripspace start PROJECT --json`, read the onboarding instructions and agent docs, and complete the connection.
3. Check the existing project and tell me the next steps for building and deploying.

If connection approval is required, approve it on the JoripSpace screen and give the one-time connection code to your agent.

Connect an AI agent

start gives your agent the project status and development guidance. Once connected, describe what you want to build in the same conversation.

AGENTS.md

Project development guidance for your agent, with JoripSpace connection information added to your existing instructions.

CLAUDE.md

Links Claude Code to AGENTS.md. If the guidance is not loaded, ask your agent to read the file.

Connection details

onboarding.invocation contains the command path, arguments and working folder your agent uses for subsequent commands.

The CLI connection works without extra plugins or MCP setup. Use a coding agent with terminal, file and network access.

Install and run the CLI

Windows, macOS and Linux require Node.js 18 or later and npm. Use a supported Node.js LTS for new environments. Global installs update when you run npm install -g @joripspace/cli@latest again.

Run without a global install

npx -y @joripspace/cli@latest start PROJECT

Human output or agent JSON

For terminal use, run commands without --json to follow the interactive prompts. For agents and scripts, add --json to receive structured output without opening a browser or waiting for terminal input. It does not grant additional permissions or accept project agreements.

joripspace start PROJECT --json

If login is required, open the connection URL from the response in your browser. Approve the connection, replace CONNECTION_CODE below with the one-time code, then run login and start again.

joripspace login --code "CONNECTION_CODE" --json

Create a Free project or connect an existing one

joripspace create --name my-new-app
joripspace start my-new-app

create requires login, validates names with the same rules as the website, and asks for the existing required agreements. start connects to an existing project and never creates one on a failed lookup. For agent creation, use create --json to receive all agreement texts, explain them in the user’s language and obtain explicit consent before passing the agreement flags.

Saved login and sign-out

Login credentials are saved in Windows Credential Manager, macOS Keychain or Linux Secret Service and can be reused across project folders under the same OS account. In environments without an available OS credential store, the CLI uses the Git-ignored .env.joripspace file in the selected folder. An error while writing to or verifying the OS store stops login.

logout removes the current account’s OS credential and the current folder’s saved credentials. Other legacy folders and caller-supplied environment tokens are separate; logout does not revoke server tokens. Use --cwd for another folder and quote paths containing spaces. Ordinary application .env files are not used for CLI login.

joripspace logout

Check commands

joripspace --version
joripspace --help
joripspace start --help

CLI command reference, reports and token revocation · Task workflows

MCP setup and authentication

JoripSpace provides a remote Streamable HTTP MCP server. Register the URL in your client; no local JoripSpace MCP server package is required.

https://api.joripspace.com/mcp

Codex CLI

codex mcp add joripspace --url https://api.joripspace.com/mcp
codex mcp login joripspace

Finish browser authorization, then check the connection with codex mcp list or /mcp in Codex. Reload or start a new agent session if the new server is not visible.

Claude Code

claude mcp add --transport http joripspace --scope user https://api.joripspace.com/mcp

In Claude Code, run /mcp, select JoripSpace and finish browser authorization. The user scope makes this connection available across your projects.

Other HTTP MCP clients

In the client’s MCP settings, add a remote HTTP server named joripspace with the URL above, then use its sign-in or OAuth action. CLI login and MCP client authentication are separate; installing the CLI does not authenticate MCP.

Once connected, ask the agent to list your JoripSpace projects and connect PROJECT. It can create a Free project after your explicit confirmation and the existing required agreements. Direct Secret registration or replacement through MCP uses the project’s web Secret page.

MCP tool reference and session authentication

Client setup references: OpenAI Docs · Claude Code

Build and deploy

Hono is the default server framework on JoripSpace. Build APIs and web pages in one project, then follow the Hono guide to run and deploy a sample app.

1. Check the current state

   Review the existing source, run scripts and the next action returned by start.

2. Implement and verify locally

   Describe the feature, run the project build and checks, then verify the screen and behavior.

3. Deploy to JoripSpace

   Connect GitHub and select the repository on the project’s Deployment tab. With branch-push deployment, an agent push to the configured branch triggers the existing GitHub Actions workflow; release deployment follows the configured release trigger. Otherwise use the project’s CLI deployment command.

4. Check the public address

   Verify the deployment result and confirm the requested feature works at the live URL.

Inspect the current project, implement the requested feature, verify it locally, deploy it to JoripSpace, and report the live URL and verification results.

Database and storage

Database · env.DB

Store structured data that the service reads and updates. Design indexes with the actual query conditions.

Storage · env.STORAGE

Store uploaded and generated files. Keep file metadata in the database when needed.

Files included in deployment

Keep fixed site assets such as logos in source. Manage uploaded files separately.

joripspace db --help
joripspace storage --help

Keep external service secrets in project Secrets, never in browser code or a public repository.

Manage project Secrets

Open your project’s Secrets tab to add or replace a key. You can also follow the Secret management link returned by the CLI or MCP. The page is available at /projects/PROJECT/?tab=secrets.

joripspace secret list --project PROJECT
joripspace secret generate --project PROJECT --name SESSION_SECRET

Register or replace a value with the CLI

In automation, supply the value through standard input. Use set or update to add a key or replace its value.

joripspace secret set --project PROJECT --name API_KEY --value-stdin --json
joripspace secret update --project PROJECT --name API_KEY --value-stdin --json

set and update save a new binding or replace an existing one. An agent or Secret manager must supply the actual value through standard input; these commands do not prompt for a value. The original UTF-8 input, including newlines, is preserved. Values are not returned. Use the web Secret page when you want to type a value yourself.

MCP supports Secret metadata listing and value-blind generation. Direct registration, replacement and deletion use the web page; Secret deletion is also web-only in the CLI. Keep values out of chat, command arguments, browser code, public repositories and logs.

Troubleshooting

Resources and support

Contact: [email protected]