wehub-resource-sync
71 lines
1.6 KiB
ReStructuredText
71 lines
1.6 KiB
ReStructuredText
Installation
|
|
============
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
GOD currently expects:
|
|
|
|
- macOS/Linux: Python 3.11 or newer, Node.js and ``npm``, ``uv``, and ``screen``.
|
|
- Windows: PowerShell 5.1+ and ``winget``. The PowerShell entrypoint auto-installs missing Git, Node.js LTS/npm, and ``uv``; ``uv`` supplies the managed Python runtime.
|
|
|
|
On macOS:
|
|
|
|
.. code-block:: bash
|
|
|
|
brew install python node uv screen
|
|
|
|
Clone
|
|
-----
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/XiaoLuoLYG/GOD.git
|
|
cd GOD
|
|
|
|
The repo contains the integrated AgentSociety and JiuwenClaw checkouts needed by the local GOD stack.
|
|
|
|
Install by starting
|
|
-------------------
|
|
|
|
The recommended install path is the same as the start path:
|
|
|
|
.. code-block:: bash
|
|
|
|
./scripts/god.sh start
|
|
|
|
On Windows PowerShell, use:
|
|
|
|
.. code-block:: powershell
|
|
|
|
.\scripts\god.cmd start
|
|
|
|
On first run, the script creates ``.env`` from ``.env.example``, installs backend/runtime/frontend dependencies, opens the setup wizard, and waits for model configuration.
|
|
|
|
Install only
|
|
------------
|
|
|
|
To check or install dependencies without opening the full live stack:
|
|
|
|
.. code-block:: bash
|
|
|
|
./scripts/god.sh setup
|
|
|
|
If you already know the dependencies are ready and want to skip setup checks during startup:
|
|
|
|
.. code-block:: bash
|
|
|
|
GOD_SKIP_SETUP=1 ./scripts/god.sh start
|
|
|
|
Local-only files
|
|
----------------
|
|
|
|
Do not commit local runtime state:
|
|
|
|
- ``.env``
|
|
- ``.god/``
|
|
- ``.live/``
|
|
- ``agentsociety/quick_experiments/**/run*/``
|
|
- generated ``Generated_Agent_*.png`` sprite files
|
|
- generated map packages under ``agentsociety/custom/generated_maps/``
|