run-llama / create-llama

The easiest way to get started with LlamaIndex
MIT License
718 stars 86 forks source link

Proxy support added via global agent #76

Closed mohdamir closed 3 months ago

mohdamir commented 3 months ago

Problem: If user is on enterprise network and working behind proxy, create-llama is not able to connect to external servers.

Solution: Global Agent is used which will apply the proxy after reading them from evn. If proxy is not set it will be ignored. User can set the proxy URL as follows before running the create-llama tool.

Bash export GLOBAL_AGENT_HTTP_PROXY=http://localhost:8080 (replace by actual proxy URL) export GLOBAL_AGENT_HTTPS_PROXY=https://localhost:8080 (replace by actual proxy URL)

Cmd set GLOBAL_AGENT_HTTP_PROXY=http://localhost:8080 (replace by actual proxy URL) set GLOBAL_AGENT_HTTPS_PROXY=https://localhost:8080 (replace by actual proxy URL)

Summary by CodeRabbit

changeset-bot[bot] commented 3 months ago

🦋 Changeset detected

Latest commit: 67919eafdf13e81c9b0485c156feb82bb9a0b536

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ------------ | ----- | | create-llama | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent update introduces proxy support for network calls in the create-llama module. It allows users to set a proxy URL via an environment variable. Key changes include adding a proxy initialization function, updating dependencies, and configuring type roots in TypeScript. This enhancement ensures smoother network operations behind proxies.

Changes

Files Change Summary
.changeset/tame-crews-trade.md Introduces proxy support for create-llama operations.
index.ts Adds a check for the GLOBAL_AGENT_HTTP_PROXY environment variable to enable proxy setup.
package.json Updates dependencies to include global-agent, pnpm, and @types/global-agent.
tsconfig.json Adds "typeRoots" to include additional type roots for TypeScript.
types/global-agent.d.ts Declares a module for "global-agent/bootstrap" with an anyType export.

🌟 In code's vast realm, a proxy's grace, Llamas connect at a brisk pace. With global agents set in place, Network calls now find their space. Dependencies aligned, types refined, Through proxies, our code's enshrined. 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
marcusschiesser commented 3 months ago

Thanks @mohdamir added to create-llama@0.1.7