{"id":28402098,"url":"https://github.com/chainlit/chainlit-help","last_synced_at":"2026-03-13T21:36:23.753Z","repository":{"id":275647035,"uuid":"760453282","full_name":"Chainlit/chainlit-help","owner":"Chainlit","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-15T13:03:01.000Z","size":1298,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-01T22:43:09.089Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chainlit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-02-20T12:59:14.000Z","updated_at":"2025-05-06T07:17:33.000Z","dependencies_parsed_at":"2025-04-15T14:32:36.403Z","dependency_job_id":null,"html_url":"https://github.com/Chainlit/chainlit-help","commit_stats":null,"previous_names":["chainlit/chainlit-rag-copilot","chainlit/chainlithelp","chainlit/chainlit-help"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Chainlit/chainlit-help","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fchainlit-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fchainlit-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fchainlit-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fchainlit-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chainlit","download_url":"https://codeload.github.com/Chainlit/chainlit-help/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chainlit%2Fchainlit-help/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30476424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-13T20:45:58.186Z","status":"ssl_error","status_checked_at":"2026-03-13T20:45:20.133Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-06-01T14:36:28.170Z","updated_at":"2026-03-13T21:36:23.724Z","avatar_url":"https://github.com/Chainlit.png","language":"Python","readme":"# Chainlit Help\n\nThe Chainlit copilot for the Chainlit [documentation](https://docs.chainlit.io/get-started/overview).\n\n## How to use?\n\n### The Chainlit Application\n\n- `cp app/.env.example app/.env`\n- Obtain a Literal API key [here](https://docs.getliteral.ai/python-client/get-started/authentication#how-to-get-my-api-key)\n- `pip install -r app/requirements.txt`\n- `chainlit run app/app.py`\n\n### The Chainlit Copilot\n\n- Make sure the Chainlit application is running.\n- `python -m http.server 3004 --directory copilot`\n\n### Create context\n\n#### Codebase context\n\nGo to https://gitingest.com for repo `https://github.com/chainlit/chainlit` with exclude\n```\n.editorconfig, .eslintignore, .eslintrc, .npmrc, .prettierrc, *.json, *.lock, *.yaml, *.toml, *.md, *.js, .github, .husky, cypress, frontend, images, libs/copilot, */tests,README.md, **/__pycache__, **/*.spec.py, **/wavtools, **/.git, */__init__.py, backend, LICENSE, *.config.ts\n```\nto generate `codebase.txt`\n\n#### Documentation context\n\nGo to https://gitingest.com for repo `https://github.com/chainlit/docs` with exclude `*.json` to generate `documentation.txt`\n\n#### Cookbook context\n\nGo to https://gitingest.com for repo `https://github.com/chainlit/cookbook` with include `map-canvas/, realtime-assistant/` to generate `cookbook.txt`\n\n## How to contribute?\n\nMake all the changes you want to the application, then validate them in local against [Test dataset to ship RAG](https://cloud.getliteral.ai/projects/chainlit-doc-JicvnMkIcofi/datasets/a24f9233-d03e-4dc4-98c6-c5fec438f757).\n\nFollow the `Experiments.ipynb` notebook to run your experiments against that dataset.\n\nTo have a locally exposed endpoint you can test with, run the `main.py` Fast API server from the root directory:\n\n```shell\nuvicorn --app-dir app main:app --host 0.0.0.0 --port 80\n```\n\nThis will expose the http://localhost:80/app/ endpoint where you can put your question at the end.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainlit%2Fchainlit-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchainlit%2Fchainlit-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchainlit%2Fchainlit-help/lists"}