JoripSpace documentation

Build a web app with an AI agent and deploy it on JoripSpace.

JoripSpace is a platform for building and deploying web apps with AI agents. Connect a project server, database and storage to turn an idea into a real service.

Quick startOpen my projects

Connect an AI agent

Read the project and agent guidance and continue the work.

Install and run the CLI

Use the same commands on Windows, macOS and Linux.

Build and deploy

Review existing code and verify the result at a live service address.

Database and storage

Manage service data and uploaded files in a project.

Developer guides and examples

Hono and project structure

Organize files by responsibility and take an SSR web app from local development to deployment.

SSR and SEO

Include searchable content and metadata in the initial HTML response.

Database and file storage

Examples for bindings, migrations, indexes and permission-aware file management.

Authentication and Secrets

Separate platform CLI authorization from app-user login and protect sessions and secret keys.

Cron and scheduled jobs

Register UTC schedules, protect internal calls and verify repeated execution.

Payment gateway integration

Implement server-side orders, payment confirmation, reconciliation, webhooks and recurring billing.

Realtime WebSocket v1

Use the legacy public-room connection and its message and history formats.

Realtime WebSocket v2

Use server-authenticated publishing, user access grants, SDK recovery and a transactional order outbox.

Deployment and operations

Verify static assets, domains, logs, rollback procedures and mail integration.

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.

Message for an AI agent
Start the JoripSpace project `PROJECT`.

1. Install or update the official CLI with `npm install -g @joripspace/cli@latest`.
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 returns project status, onboarding guidance and the next action. The agent reads the returned instructions and continues in the current conversation.

AGENTS.md
Records project work instructions and the JoripSpace guidance block.
CLAUDE.md
Links to AGENTS.md. In environments that do not load it automatically, ask the agent to read it directly.
Next invocation
onboarding.invocation returns the executable path, arguments and working directory for the current session.

Plugins, skills and MCP registration are not required for this flow. A chat-only environment without terminal, file or network access cannot run commands.

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.

Run with npx without installing

Terminal
npx -y @joripspace/cli@latest start PROJECT --json

Install or update globally

Terminal
npm install -g @joripspace/cli@latest
joripspace --version
joripspace start PROJECT --json

Check commands

Terminal
joripspace --help
joripspace start --help
joripspace deploy --help

Use --cwd for another folder. Credentials are saved in the Git-ignored .env.joripspace file.

Build and deploy

  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

    Follow the configured branch and trigger when GitHub deployment is connected. 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.

Build and deploy request
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.
Terminal
joripspace db --help
joripspace storage --help

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

Troubleshooting

I cannot find the joripspace command

Run npx -y @joripspace/cli@latest --version. Check the global install path with npm root -g.

Connection approval is required

Approve the connection URL and use the one-time code within five minutes.

The wrong project is connected

Check your account access, project name and the project recorded in .joripspace/project.

Connection succeeded but work did not start

Ask the agent to read the returned onboarding guidance and AGENTS.md, then describe the feature you want.

Resources and support

CLI source and docsnpm packageAgent onboarding

Contact: [email protected]