diff --git a/README.md b/README.md index a7e340fc..e57c8565 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ try calling the GitHub.SetStarred tool with a message like "Star the arcade-ai r === Arcade Chat === -Chatting with Arcade Gateway at https://api.arcade.dev +Chatting with Arcade Engine at https://api.arcade.dev User sam@arcade.dev: star the arcadeai/arcade-ai repo @@ -252,10 +252,10 @@ arcade worker rm demo-worker Once deployed, your toolkit is immediately available through the Arcade platform. You can now call your tools through the playground, LLM API, or Tools API without any additional setup. -For local development and testing when running the Arcade Gateway locally or tunneling to it, you can -use `arcade serve` to host your toolkit locally and connect it to the Arcade Gateway. +For local development and testing when running the Arcade Engine locally or tunneling to it, you can +use `arcade serve` to host your toolkit locally and connect it to the Arcade Engine. -If you are running the Arcade Gateway locally, go to localhost:9099 (or other local address) +If you are running the Arcade Engine locally, go to localhost:9099 (or other local address) and add the worker address in the "workers" page. ## Calling your tools diff --git a/arcade/arcade/cli/main.py b/arcade/arcade/cli/main.py index da3935f3..4c0071eb 100644 --- a/arcade/arcade/cli/main.py +++ b/arcade/arcade/cli/main.py @@ -164,13 +164,13 @@ def show( PROD_ENGINE_HOST, "-h", "--host", - help="The Arcade Gateway address to show the tools/toolkits of.", + help="The Arcade Engine address to show the tools/toolkits of.", ), local: bool = typer.Option( False, "--local", "-l", - help="Show the local environment's catalog instead of an Arcade Gateway's catalog.", + help="Show the local environment's catalog instead of an Arcade Engine's catalog.", ), port: Optional[int] = typer.Option( None, @@ -181,12 +181,12 @@ def show( force_tls: bool = typer.Option( False, "--tls", - help="Whether to force TLS for the connection to the Arcade Gateway. If not specified, the connection will use TLS if the Gateway URL uses a 'https' scheme.", + help="Whether to force TLS for the connection to the Arcade Engine. If not specified, the connection will use TLS if the engine URL uses a 'https' scheme.", ), force_no_tls: bool = typer.Option( False, "--no-tls", - help="Whether to disable TLS for the connection to the Arcade Gateway.", + help="Whether to disable TLS for the connection to the Arcade Engine.", ), debug: bool = typer.Option(False, "--debug", "-d", help="Show debug information"), ) -> None: @@ -211,23 +211,23 @@ def chat( PROD_ENGINE_HOST, "-h", "--host", - help="The Arcade Gateway address to send chat requests to.", + help="The Arcade Engine address to send chat requests to.", ), port: int = typer.Option( None, "-p", "--port", - help="The port of the Arcade Gateway.", + help="The port of the Arcade Engine.", ), force_tls: bool = typer.Option( False, "--tls", - help="Whether to force TLS for the connection to the Arcade Gateway. If not specified, the connection will use TLS if the gateway URL uses a 'https' scheme.", + help="Whether to force TLS for the connection to the Arcade Engine. If not specified, the connection will use TLS if the engine URL uses a 'https' scheme.", ), force_no_tls: bool = typer.Option( False, "--no-tls", - help="Whether to disable TLS for the connection to the Arcade Gateway.", + help="Whether to disable TLS for the connection to the Arcade Engine.", ), ) -> None: """ @@ -346,28 +346,28 @@ def evals( LOCALHOST, "-h", "--host", - help="The Arcade Gateway address to send chat requests to.", + help="The Arcade Engine address to send chat requests to.", ), cloud: bool = typer.Option( False, "--cloud", - help="Whether to run evaluations against the Arcade Cloud Gateway. Overrides the 'host' option.", + help="Whether to run evaluations against the Arcade Cloud Engine. Overrides the 'host' option.", ), port: int = typer.Option( None, "-p", "--port", - help="The port of the Arcade Gateway.", + help="The port of the Arcade Engine.", ), force_tls: bool = typer.Option( False, "--tls", - help="Whether to force TLS for the connection to the Arcade Gateway. If not specified, the connection will use TLS if the gateway URL uses a 'https' scheme.", + help="Whether to force TLS for the connection to the Arcade Engine. If not specified, the connection will use TLS if the engine URL uses a 'https' scheme.", ), force_no_tls: bool = typer.Option( False, "--no-tls", - help="Whether to disable TLS for the connection to the Arcade Gateway.", + help="Whether to disable TLS for the connection to the Arcade Engine.", ), ) -> None: """ @@ -387,12 +387,12 @@ def evals( console.print( Text.assemble( - ("\nRunning evaluations against Arcade Gateway at ", "bold"), + ("\nRunning evaluations against Arcade Engine at ", "bold"), (base_url, "bold blue"), ) ) - # Try to hit /health endpoint on gateway and warn if it is down + # Try to hit /health endpoint on engine and warn if it is down with Arcade(api_key=config.api.key, base_url=base_url) as client: log_engine_health(client) @@ -587,23 +587,23 @@ def deploy( PROD_ENGINE_HOST, "--host", "-h", - help="The Arcade Gateway host to register the worker to.", + help="The Arcade Engine host to register the worker to.", ), port: int = typer.Option( None, "--port", "-p", - help="The port of the Arcade Gateway host.", + help="The port of the Arcade Engine host.", ), force_tls: bool = typer.Option( False, "--tls", - help="Whether to force TLS for the connection to the Arcade Gateway. If not specified, the connection will use TLS if the gateway URL uses a 'https' scheme.", + help="Whether to force TLS for the connection to the Arcade Engine. If not specified, the connection will use TLS if the engine URL uses a 'https' scheme.", ), force_no_tls: bool = typer.Option( False, "--no-tls", - help="Whether to disable TLS for the connection to the Arcade Gateway.", + help="Whether to disable TLS for the connection to the Arcade Engine.", ), ) -> None: """ @@ -645,13 +645,13 @@ def dashboard( PROD_ENGINE_HOST, "-h", "--host", - help="The Arcade Gateway host that serves the dashboard.", + help="The Arcade Engine host that serves the dashboard.", ), port: Optional[int] = typer.Option( None, "-p", "--port", - help="The port of the Arcade Gateway.", + help="The port of the Arcade Engine.", ), local: bool = typer.Option( False, @@ -662,17 +662,17 @@ def dashboard( force_tls: bool = typer.Option( False, "--tls", - help="Whether to force TLS for the connection to the Arcade Gateway.", + help="Whether to force TLS for the connection to the Arcade Engine.", ), force_no_tls: bool = typer.Option( False, "--no-tls", - help="Whether to disable TLS for the connection to the Arcade Gateway.", + help="Whether to disable TLS for the connection to the Arcade Engine.", ), ) -> None: """Opens the Arcade Dashboard in a web browser. - The Dashboard is a web-based Arcade user interface that is served by the Arcade Gateway. + The Dashboard is a web-based Arcade user interface that is served by the Arcade Engine. """ if local: host = "localhost" diff --git a/docker/README.md b/docker/README.md index 0be99c50..eed2337f 100644 --- a/docker/README.md +++ b/docker/README.md @@ -55,15 +55,15 @@ docker compose up This command will build and start all the services defined in the `docker-compose.yml` file and make their ports available to your host machine. -### 4. Verify the Gateway is Running +### 4. Verify the Engine is Running -In a separate terminal window, check if the gateway is running: +In a separate terminal window, check if the engine is running: ```bash curl http://localhost:9099/v1/health ``` -You should receive a response indicating that the gateway is healthy: +You should receive a response indicating that the engine is healthy: ```json { "status": "healthy" } @@ -108,7 +108,7 @@ docker compose up ## Troubleshooting -- **Gateway Health Check Fails**: Ensure that all environment variables are correctly set in the `.env` file and that the services have started without errors. +- **Engine Health Check Fails**: Ensure that all environment variables are correctly set in the `.env` file and that the services have started without errors. - **Port Conflicts**: If the default ports are already in use, modify the ports in the `docker-compose.yml` file. - **Authentication Errors**: Double-check the client IDs and secrets provided for auth providers. diff --git a/examples/call_a_tool_directly.py b/examples/call_a_tool_directly.py index 86807518..c913783e 100644 --- a/examples/call_a_tool_directly.py +++ b/examples/call_a_tool_directly.py @@ -33,7 +33,7 @@ if __name__ == "__main__": cloud_host = "https://api.arcade.dev" client = Arcade( - base_url=cloud_host, # Alternatively, use http://localhost:9099 if you are running Arcade Gateway locally, or any base_url if you're hosting elsewhere + base_url=cloud_host, # Alternatively, use http://localhost:9099 if you are running Arcade Engine locally, or any base_url if you're hosting elsewhere ) user_id = "you@example.com" diff --git a/examples/call_a_tool_directly_with_auth.py b/examples/call_a_tool_directly_with_auth.py index fcd2fe41..af0bab7b 100644 --- a/examples/call_a_tool_directly_with_auth.py +++ b/examples/call_a_tool_directly_with_auth.py @@ -44,7 +44,7 @@ def call_auth_tool(client: Arcade, user_id: str) -> None: if __name__ == "__main__": client = Arcade( - base_url="https://api.arcade.dev", # Alternatively, use http://localhost:9099 if you are running Arcade Gateway locally, or any base_url if you're hosting elsewhere + base_url="https://api.arcade.dev", # Alternatively, use http://localhost:9099 if you are running Arcade Engine locally, or any base_url if you're hosting elsewhere ) user_id = "you@example.com" diff --git a/examples/call_a_tool_with_llm.py b/examples/call_a_tool_with_llm.py index 8d41963e..ad7c98e0 100644 --- a/examples/call_a_tool_with_llm.py +++ b/examples/call_a_tool_with_llm.py @@ -29,7 +29,7 @@ if __name__ == "__main__": openai_client = OpenAI( api_key=arcade_api_key, - base_url=cloud_host, # Alternatively, use http://localhost:9099/v1 if you are running Arcade Gateway locally + base_url=cloud_host, # Alternatively, use http://localhost:9099/v1 if you are running Arcade Engine locally ) chat_result = call_tool_with_openai(openai_client)