Skip to content

Commit fa8431f

Browse files
committed
README update with pip install
1 parent 2bf76c6 commit fa8431f

File tree

1 file changed

+10
-54
lines changed

1 file changed

+10
-54
lines changed

README.md

Lines changed: 10 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,7 @@ Before installing TerraVision, ensure you have:
9494
### Install TerraVision
9595

9696
```bash
97-
# Clone repository
98-
git clone https://github.com/patrickchugh/terravision.git
99-
cd terravision
100-
101-
# Install dependencies
102-
pip install -r requirements.txt
97+
pip install terravision
10398
```
10499

105100
### Verify Terraform Setup
@@ -129,16 +124,16 @@ export GOOGLE_CREDENTIALS="path/to/service-account-key.json"
129124
# Or: gcloud auth application-default login
130125

131126
# Test Terraform can initialize and plan
132-
cd tests/fixtures/aws_terraform/static-website # or azure_terraform/ or gcp_terraform/
127+
cd tests/fixtures/aws_terraform/static-website # or azure_terraform/test_vm_vmss
133128
terraform init
134129
terraform plan
135130
# Should complete without errors
136131
cd -
137132
```
138133

139-
**Note**: TerraVision needs Terraform to successfully run `terraform plan` to parse your infrastructure. Cloud credentials are required for Terraform to validate resources, but TerraVision itself never accesses your cloud account.
134+
**Note**: TerraVision needs Terraform to successfully run `terraform plan` to parse your infrastructure. Cloud credentials are required for TERRAFORM to validate resources and resolve functions, but TerraVision itself never accesses your cloud account.
140135

141-
**Important for Terraform Enterprise Users**: TerraVision automatically forces local backend execution (ignoring remote state) to generate diagrams showing the complete infrastructure definition, not just deltas. This ensures accurate architecture visualization regardless of your configured backend.
136+
**Important for Terraform Enterprise and Remote Backend Users**: TerraVision automatically forces local backend execution (ignoring remote state) to generate diagrams showing the complete infrastructure definition, not just deltas. This ensures accurate architecture visualization regardless of your configured backend.
142137

143138
### Try It Out!
144139

@@ -148,13 +143,10 @@ Generate your first diagram using our example Terraform code:
148143
# Example 1: EKS cluster with managed nodes and OIDC
149144
./terravision.py draw --source tests/fixtures/aws_terraform/eks_managed_nodes --show
150145

151-
# Example 2: Step Functions orchestrating multiple services
152-
./terravision.py draw --source tests/fixtures/aws_terraform/stepfunctions_multi_service --show
153-
154-
# Example 3: SageMaker notebook in VPC with security
155-
./terravision.py draw --source tests/fixtures/aws_terraform/sagemaker_notebook_vpc --show
146+
# Example 2: Azure VM stack set
147+
./terravision.py draw --source tests/fixtures/azure_terraform/test_vm_vmss --show
156148

157-
# Example 4: From a public Git repository and only look at subfolder /aws/wordpress_fargate (note double slash)
149+
# Example 3: From a public Git repository and only look at subfolder /aws/wordpress_fargate (note double slash)
158150
./terravision.py draw --source https://github.com/patrickchugh/terraform-examples.git//aws/wordpress_fargate --show
159151
```
160152

@@ -169,43 +161,7 @@ Generate your first diagram using our example Terraform code:
169161

170162
---
171163

172-
## Installation
173-
174-
### Method 1: Quick Install (Recommended for Users)
175-
176-
**macOS/Linux:**
177-
178-
```bash
179-
git clone https://github.com/patrickchugh/terravision.git
180-
cd terravision
181-
pip install -r requirements.txt
182-
chmod +x terravision.py
183-
ln -s $(pwd)/terravision.py $(pwd)/terravision
184-
export PATH=$PATH:$(pwd)
185-
```
186-
187-
**Windows:**
188-
189-
```powershell
190-
git clone https://github.com/patrickchugh/terravision.git
191-
cd terravision
192-
pip install -r requirements.txt
193-
echo @python "%~dp0terravision.py" %* > terravision.bat
194-
copy terravision.bat C:\Windows\System32\
195-
```
196-
197-
### Method 2: Poetry Install (Recommended for Developers)
198-
199-
```bash
200-
# Install Poetry
201-
curl -sSL https://install.python-poetry.org | python3 -
202-
203-
# Install TerraVision
204-
git clone https://github.com/patrickchugh/terravision.git
205-
cd terravision
206-
poetry install
207-
source $(poetry env info --path)/bin/activate
208-
```
164+
## Installation for Developers / Power Users
209165

210166
**Detailed installation instructions**: See [docs/INSTALLATION.md](docs/INSTALLATION.md)
211167

@@ -279,8 +235,8 @@ terravision graphdata --source ./terraform --outfile resources.json
279235

280236
| Provider | Status | Resources Supported |
281237
| ---------------- | ------------------ | ------------------- |
282-
| **AWS** | ✅ Full Support | 200+ services |
283-
| **Google Cloud** | 🔄 Coming Soon | Core services |
238+
| **AWS** | ✅ Full Support | 200+ services |
239+
| **Google Cloud** | 🔄 Coming Soon | None |
284240
| **Azure** | 🔄 Partial Support | Core services |
285241

286242
---

0 commit comments

Comments
 (0)