- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases, Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list; 15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them. - The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables, links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback. - ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked); the packaged copy ui/docs first, else the repository's docs/ide. - Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php puts them in code updates, bin/jumphp ide syncs them. - Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest (path traversal refused), the i18n test covers the new texts in 14 languages. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2.7 KiB
Getting started
Install and start
- Desktop: install the IDE with its installer (jumphp.net), or from a JumPHP checkout run
bin/jumphp ide(the IDE runs from the checkout's sources;bin/jumphp ide --installaddsjumphp-ideand a menu entry). The installed IDE updates itself (Help, logs and updates). - Web:
https://jumphp.net/idein a browser, signed in with your jumphp.net account. It works on your published projects with drafts on top; branches, local runs, Docker and SSH are desktop only.
The welcome screen
Without a project open, the IDE shows its welcome screen:
- Sign in with jumphp.net (desktop: your browser opens, you authorize, the IDE gets a token you can revoke in the studio). Your projects (your Git repositories) are listed; a click clones and opens one.
- Open a folder: any folder of the disk becomes a project (a JumPHP project, a web site, any PHP code).
- Clone a repository: any Git address.
- New Project: a game, a graphic / mobile / desktop / CLI app, an IDE plugin, a hybrid game, an engine extension, an Amstrad
CPC remake (the
.dskstays local), a port, or a web site (Symfony, Laravel, WordPress, PrestaShop, Sylius, PHP: see Web sites). It is made on this computer only; nothing goes online until you publish. - News: JumPHP's news and the IDE's updates, in your language.
- A project of the list has a trash button (its folder; unticked boxes also delete its repository and jumphp.net project).
Quick editor and "Open with JumPHP"
jumphp-ide <file> opens one file in a light window: Monaco only, no project, no index, no Git. Ctrl+S saves (a file changed by
another program meanwhile is not overwritten without a yes), Ctrl+O opens another file, Open the folder as a project opens the
whole IDE. HTML, CSS, Twig and Markdown have a Code / Both / Preview switch; binary files open in hexadecimal.
jumphp-ide <folder> opens a folder as a project. A second jumphp-ide <file> hands the file to the IDE already open.
Tools > Integrate with the System… adds "Open with JumPHP" (a file) and "Open as a project in JumPHP" (a folder) to the file manager, for your user only: Windows (registry keys of the current user), Linux (Nautilus, Nemo, Caja, Dolphin, the "Open with" lists). Not on macOS yet. It needs the installed IDE.
Projects kept up to date
When a JumPHP project opens, the IDE brings its JumPHP files (bin/jumphp, the engine, tools, skeletons) to the newest JumPHP; never
games/ nor your README. Files you changed are named and you choose. A repository that holds only a game runs through the IDE's own
copy of JumPHP.