{"id":21519183,"url":"https://github.com/dcspark/shinkai-node","last_synced_at":"2026-01-28T05:37:25.624Z","repository":{"id":243113805,"uuid":"658517501","full_name":"dcSpark/shinkai-node","owner":"dcSpark","description":"Shinkai is a two click install AI manager (Ollama compatible for Windows, Mac and Linux). It lets you download/use AI models, RAG, and performs actions for you with tooling (very soon).","archived":false,"fork":false,"pushed_at":"2025-03-13T15:29:45.000Z","size":114038,"stargazers_count":43,"open_issues_count":10,"forks_count":9,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-14T04:48:57.547Z","etag":null,"topics":["ai","chatgpt","gui","llama3","llm","ollama","qwen","rag"],"latest_commit_sha":null,"homepage":"https://shinkai.com","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dcSpark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-26T00:55:29.000Z","updated_at":"2025-03-13T13:31:19.000Z","dependencies_parsed_at":"2024-06-20T03:31:54.799Z","dependency_job_id":"a3fc801b-9cd5-4011-969d-0ad6c1ef750e","html_url":"https://github.com/dcSpark/shinkai-node","commit_stats":{"total_commits":2792,"total_committers":17,"mean_commits":"164.23529411764707","dds":0.4842406876790831,"last_synced_commit":"a0d4789f4cee8ae6472c2bd76936b12b12b67f81"},"previous_names":["dcspark/shinkai-node"],"tags_count":105,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcSpark%2Fshinkai-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcSpark%2Fshinkai-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcSpark%2Fshinkai-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcSpark%2Fshinkai-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dcSpark","download_url":"https://codeload.github.com/dcSpark/shinkai-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056425,"owners_count":20390719,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","chatgpt","gui","llama3","llm","ollama","qwen","rag"],"created_at":"2024-11-24T00:56:05.128Z","updated_at":"2026-01-04T02:18:15.037Z","avatar_url":"https://github.com/dcSpark.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"files/icon.png\"/\u003e\u003cbr/\u003e\n  Shinkai Node\n\u003c/h1\u003e\n\u003cp align=\"center\"\u003eShinkai allows you to create AI agents without touching code. Define tasks, schedule actions, and let Shinkai write custom code for you. Native crypto support included.\u003cbr/\u003e\u003cbr/\u003e There is a companion repo called Shinkai Apps which contains the frontend that encapsulates this project, you can find it \u003ca href=\"https://github.com/dcSpark/shinkai-apps\"\u003ehere\u003c/a\u003e.\u003c/p\u003e\u003cbr/\u003e\n\n## Documentation\n\nGeneral Documentation: [https://docs.shinkai.com](https://docs.shinkai.com)\n\n## Installation (Local Compilation)\n\n### Prerequisites\n\n- Rust version \u003e= 1.85 (required for `std::fs::exists` functionality)\n\nPlease refer to the installation instructions for your operating system:\n\n- [Windows Installation Instructions](docs/installation/windows.md)\n- [Linux Installation Instructions](docs/installation/linux.md)\n- [macOS Installation Instructions](docs/installation/macos.md)\n\n## Build\n\n### Easy Build\n\n```\nsh scripts/run_node_localhost.sh\n```\n\nif you want to restart the node, you can delete the folder `storage` and run the build again. More information at [https://docs.shinkai.com/getting-started](https://docs.shinkai.com/getting-started).\n\n### Build Shinkai Rust Node\n\n```\ncargo build\n```\nNote: You must run this command from the root directory of this repo and make sure that you have set the required ENV variables.\n\n## OpenAPI\n\n### Generate schemas\n\nRun the following command to generate the schema files: \n\n```\ncargo run --example generate_openapi_docs\n```\n\nThe result will be placed in the folder `docs/openapi`.\n\n### Swagger UI\n\n```\nhttp://{NODE_IP}:{NODE_API_PORT}/v2/swagger-ui/\n```\n\nThe Swagger UI assets are not built by default to avoid network downloads during\ntests. If you want to include them, compile with the `swagger-ui` feature:\n\n```\ncargo build --features shinkai_node/swagger-ui\n```\n\n## Tests\n\nNote: You must run these tests from the root directory of this repo.\n\n### Test Shinkai Rust Node Only\n\nSimply use the following to run all rust node tests:\n\n```\nIS_TESTING=1 cargo test -- --test-threads=1\n```\n\nFor running a specific test (useful for debugging) you can use:\n\n```\nIS_TESTING=1 cargo test tcp_node_test -- --nocapture --test-threads=1\n```\n\n### Running Dockerized Tests\n\n#### Main tests\n\n```\n# Build testing image\ndocker build -t testing_image -f .github/Dockerfile .\n\n# Run tests main cargo tests\ndocker run --entrypoint /entrypoints/run-main-cargo-tests.sh testing_image\n```\n\n### Further CI Development\n\nUse `act -j test-wasm -P self-hosted=nektos/act-environments-ubuntu:18.04 --container-architecture linux/amd64` to run the tests locally in a docker container. This is useful for debugging CI issues.\n\n## Releasing a New Version\n\nWhen releasing a new version, ensure that you update the `Cargo.toml` of the shinkai-node as well as the `Cargo.toml` of the shinkai-libs/shinkai-http-api library.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcspark%2Fshinkai-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcspark%2Fshinkai-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcspark%2Fshinkai-node/lists"}