techprotrade commited on
Commit
4029646
Β·
verified Β·
1 Parent(s): 64cc286

Add loan-advisor-agent

Browse files
Files changed (1) hide show
  1. loan-advisor-agent/README.md +82 -0
loan-advisor-agent/README.md ADDED
@@ -0,0 +1,82 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # loan-advisor-agent
2
+
3
+ Simple ReAct agent
4
+ Agent generated with `agents-cli` version `0.1.3`
5
+
6
+ ## Project Structure
7
+
8
+ ```
9
+ loan-advisor-agent/
10
+ β”œβ”€β”€ app/ # Core agent code
11
+ β”‚ β”œβ”€β”€ agent.py # Main agent logic
12
+ β”‚ β”œβ”€β”€ agent_runtime_app.py # Agent Runtime application logic
13
+ β”‚ └── app_utils/ # App utilities and helpers
14
+ β”œβ”€β”€ tests/ # Unit, integration, and load tests
15
+ β”œβ”€β”€ GEMINI.md # AI-assisted development guide
16
+ └── pyproject.toml # Project dependencies
17
+ ```
18
+
19
+ > πŸ’‘ **Tip:** Use [Gemini CLI](https://github.com/google-gemini/gemini-cli) for AI-assisted development - project context is pre-configured in `GEMINI.md`.
20
+
21
+ ## Requirements
22
+
23
+ Before you begin, ensure you have:
24
+ - **uv**: Python package manager (used for all dependency management in this project) - [Install](https://docs.astral.sh/uv/getting-started/installation/) ([add packages](https://docs.astral.sh/uv/concepts/dependencies/) with `uv add <package>`)
25
+ - **agents-cli**: Agents CLI - Install with `uv tool install google-agents-cli`
26
+ - **Google Cloud SDK**: For GCP services - [Install](https://cloud.google.com/sdk/docs/install)
27
+
28
+
29
+ ## Quick Start
30
+
31
+ Install required packages:
32
+
33
+ ```bash
34
+ agents-cli install
35
+ ```
36
+
37
+ Test the agent with a local web server:
38
+
39
+ ```bash
40
+ agents-cli playground
41
+ ```
42
+
43
+ You can also use features from the [ADK](https://adk.dev/) CLI with `uv run adk`.
44
+
45
+ ## Commands
46
+
47
+ | Command | Description |
48
+ | -------------------- | ------------------------------------------------------------------------------------------- |
49
+ | `agents-cli install` | Install dependencies using uv |
50
+ | `agents-cli playground` | Launch local development environment |
51
+ | `agents-cli lint` | Run code quality checks |
52
+ | `uv run pytest tests/unit tests/integration` | Run unit and integration tests |
53
+ | `agents-cli deploy` | Deploy agent to Agent Runtime |
54
+ | `agents-cli publish gemini-enterprise` | Register deployed agent to Gemini Enterprise |
55
+
56
+ ## πŸ› οΈ Project Management
57
+
58
+ | Command | What It Does |
59
+ |---------|--------------|
60
+ | `agents-cli scaffold enhance` | Add CI/CD pipelines and Terraform infrastructure |
61
+ | `agents-cli infra cicd` | One-command setup of entire CI/CD pipeline + infrastructure |
62
+ | `agents-cli scaffold upgrade` | Auto-upgrade to latest version while preserving customizations |
63
+
64
+ ---
65
+
66
+ ## Development
67
+
68
+ Edit your agent logic in `app/agent.py` and test with `agents-cli playground` - it auto-reloads on save.
69
+
70
+ ## Deployment
71
+
72
+ ```bash
73
+ gcloud config set project <your-project-id>
74
+ agents-cli deploy
75
+ ```
76
+
77
+ To add CI/CD and Terraform, run `agents-cli scaffold enhance`.
78
+ To set up your production infrastructure, run `agents-cli infra cicd`.
79
+
80
+ ## Observability
81
+
82
+ Built-in telemetry exports to Cloud Trace, BigQuery, and Cloud Logging.