anchi-kit 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.antigravity/skills/article-extractor/SKILL.md +52 -0
- package/.antigravity/skills/artifacts-builder/SKILL.md +63 -0
- package/.antigravity/skills/aws-deployment/SKILL.md +85 -0
- package/.antigravity/skills/brainstorming/SKILL.md +73 -0
- package/.antigravity/skills/canvas-design/SKILL.md +62 -0
- package/.antigravity/skills/changelog-generator/SKILL.md +149 -0
- package/.antigravity/skills/changelog-generator/assets/changelog-template.md +60 -0
- package/.antigravity/skills/changelog-generator/scripts/generate-changelog.js +181 -0
- package/.antigravity/skills/claude-code/references/advanced-features.md +399 -0
- package/.antigravity/skills/claude-code/references/agent-skills.md +399 -0
- package/.antigravity/skills/claude-code/references/api-reference.md +498 -0
- package/.antigravity/skills/claude-code/references/best-practices.md +447 -0
- package/.antigravity/skills/claude-code/references/cicd-integration.md +428 -0
- package/.antigravity/skills/claude-code/references/common-workflows.md +119 -0
- package/.antigravity/skills/claude-code/references/configuration.md +480 -0
- package/.antigravity/skills/claude-code/references/enterprise-features.md +472 -0
- package/.antigravity/skills/claude-code/references/getting-started.md +252 -0
- package/.antigravity/skills/claude-code/references/hooks-and-plugins.md +444 -0
- package/.antigravity/skills/claude-code/references/hooks-comprehensive.md +622 -0
- package/.antigravity/skills/claude-code/references/ide-integration.md +316 -0
- package/.antigravity/skills/claude-code/references/mcp-integration.md +386 -0
- package/.antigravity/skills/claude-code/references/slash-commands.md +489 -0
- package/.antigravity/skills/claude-code/references/troubleshooting.md +456 -0
- package/.antigravity/skills/claude-code/skill.md +60 -0
- package/.antigravity/skills/code-quality/SKILL.md +273 -0
- package/.antigravity/skills/comprehensive-review/complexity.md +11 -0
- package/.antigravity/skills/comprehensive-review/index.yaml +19 -0
- package/.antigravity/skills/comprehensive-review/maintainability.md +12 -0
- package/.antigravity/skills/comprehensive-review/readability.md +12 -0
- package/.antigravity/skills/content-research-writer/SKILL.md +65 -0
- package/.antigravity/skills/csv-data-analyzer/SKILL.md +91 -0
- package/.antigravity/skills/d3-visualization/SKILL.md +65 -0
- package/.antigravity/skills/debugging/references/root-cause-analysis-methods.md +140 -0
- package/.antigravity/skills/engineering-discipline/incremental-change.md +15 -0
- package/.antigravity/skills/engineering-discipline/index.yaml +30 -0
- package/.antigravity/skills/engineering-discipline/planning-first.md +18 -0
- package/.antigravity/skills/engineering-discipline/reasoning-clarity.md +19 -0
- package/.antigravity/skills/engineering-discipline/verify-before-commit.md +17 -0
- package/.antigravity/skills/file-organizer/SKILL.md +64 -0
- package/.antigravity/skills/git-automation/SKILL.md +68 -0
- package/.antigravity/skills/git-automation/references/branch-finishing.md +64 -0
- package/.antigravity/skills/impact-scoring/SKILL.md +219 -0
- package/.antigravity/skills/kaizen/SKILL.md +94 -0
- package/.antigravity/skills/performance-patterns/SKILL.md +209 -0
- package/.antigravity/skills/playwright-testing/SKILL.md +115 -0
- package/.antigravity/skills/playwright-testing/references/playwright-patterns.md +122 -0
- package/.antigravity/skills/prompt-engineering/SKILL.md +126 -0
- package/.antigravity/skills/prompt-engineering/references/anthropic-best-practices.md +160 -0
- package/.antigravity/skills/pypict-testing/SKILL.md +79 -0
- package/.antigravity/skills/review-implementing/SKILL.md +287 -0
- package/.antigravity/skills/security-audit/SKILL.md +263 -0
- package/.antigravity/skills/software-architecture/SKILL.md +91 -0
- package/.antigravity/skills/software-architecture/references/solid-principles.md +293 -0
- package/.antigravity/skills/subagent-driven-development/SKILL.md +237 -0
- package/.antigravity/skills/test-driven-development/SKILL.md +130 -0
- package/.antigravity/skills/test-driven-development/references/tdd-patterns.md +124 -0
- package/.antigravity/skills/test-driven-development/references/testing-strategies.md +131 -0
- package/.antigravity/skills/test-fixing/SKILL.md +256 -0
- package/.antigravity/skills/theme-factory/SKILL.md +63 -0
- package/.antigravity/workflows/clean.md +333 -0
- package/.antigravity/workflows/health.md +228 -0
- package/.cursor/skills/_packs/common/pack-architecture.md +40 -0
- package/.cursor/skills/_packs/common/pack-devops.md +43 -0
- package/.cursor/skills/_packs/common/pack-productivity.md +37 -0
- package/.cursor/skills/_packs/common/pack-quality.md +41 -0
- package/.cursor/skills/_packs/data/pack-ai.md +41 -0
- package/.cursor/skills/_packs/data/pack-data-science.md +36 -0
- package/.cursor/skills/_packs/mobile/pack-mobile.md +40 -0
- package/.cursor/skills/_packs/web/pack-backend.md +61 -0
- package/.cursor/skills/_packs/web/pack-frontend.md +66 -0
- package/.cursor/skills/_packs/web3/pack-blockchain.md +37 -0
- package/.cursor/skills/advanced-coding/references/getting-started.md +93 -0
- package/.cursor/skills/advanced-coding/skill.md +34 -0
- package/.cursor/skills/template-skill/SKILL.md +6 -0
- package/README.md +1 -1
- package/docs/reference/SECURITY.md +1 -1
- package/package.json +2 -2
- package/src/cli.js +5 -5
- package/src/commands/dashboard.js +3 -3
- package/src/commands/init.js +15 -3
|
@@ -0,0 +1,472 @@
|
|
|
1
|
+
# Enterprise Features
|
|
2
|
+
|
|
3
|
+
Enterprise deployment, security, compliance, and monitoring for Cursor.
|
|
4
|
+
|
|
5
|
+
## Identity & Access Management
|
|
6
|
+
|
|
7
|
+
### SSO Integration
|
|
8
|
+
|
|
9
|
+
Support for SAML 2.0 and OAuth 2.0:
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"auth": {
|
|
14
|
+
"type": "saml",
|
|
15
|
+
"provider": "okta",
|
|
16
|
+
"entityId": "claude-code",
|
|
17
|
+
"ssoUrl": "https://company.okta.com/app/saml",
|
|
18
|
+
"certificate": "/path/to/cert.pem"
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Supported providers:**
|
|
24
|
+
- Okta
|
|
25
|
+
- Azure AD
|
|
26
|
+
- Google Workspace
|
|
27
|
+
- OneLogin
|
|
28
|
+
- Auth0
|
|
29
|
+
|
|
30
|
+
### Role-Based Access Control (RBAC)
|
|
31
|
+
|
|
32
|
+
Define user roles and permissions:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"rbac": {
|
|
37
|
+
"roles": {
|
|
38
|
+
"developer": {
|
|
39
|
+
"permissions": ["code:read", "code:write", "tools:use"]
|
|
40
|
+
},
|
|
41
|
+
"reviewer": {
|
|
42
|
+
"permissions": ["code:read", "code:review"]
|
|
43
|
+
},
|
|
44
|
+
"admin": {
|
|
45
|
+
"permissions": ["*"]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### User Management
|
|
53
|
+
|
|
54
|
+
Centralized user provisioning:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Add user
|
|
58
|
+
claude admin user add user@company.com --role developer
|
|
59
|
+
|
|
60
|
+
# Remove user
|
|
61
|
+
claude admin user remove user@company.com
|
|
62
|
+
|
|
63
|
+
# List users
|
|
64
|
+
claude admin user list
|
|
65
|
+
|
|
66
|
+
# Update user role
|
|
67
|
+
claude admin user update user@company.com --role admin
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Security & Compliance
|
|
71
|
+
|
|
72
|
+
### Sandboxing
|
|
73
|
+
|
|
74
|
+
Filesystem and network isolation:
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"sandboxing": {
|
|
79
|
+
"enabled": true,
|
|
80
|
+
"mode": "strict",
|
|
81
|
+
"filesystem": {
|
|
82
|
+
"allowedPaths": ["/workspace"],
|
|
83
|
+
"readOnlyPaths": ["/usr/lib", "/etc"],
|
|
84
|
+
"deniedPaths": ["/etc/passwd", "/etc/shadow"]
|
|
85
|
+
},
|
|
86
|
+
"network": {
|
|
87
|
+
"enabled": false,
|
|
88
|
+
"allowedDomains": ["api.anthropic.com"]
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Audit Logging
|
|
95
|
+
|
|
96
|
+
Comprehensive activity logs:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"auditLog": {
|
|
101
|
+
"enabled": true,
|
|
102
|
+
"destination": "syslog",
|
|
103
|
+
"syslogHost": "logs.company.com:514",
|
|
104
|
+
"includeToolCalls": true,
|
|
105
|
+
"includePrompts": false,
|
|
106
|
+
"retention": "90d"
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**Log format:**
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"timestamp": "2025-11-06T10:30:00Z",
|
|
115
|
+
"user": "user@company.com",
|
|
116
|
+
"action": "tool_call",
|
|
117
|
+
"tool": "bash",
|
|
118
|
+
"args": {"command": "git status"},
|
|
119
|
+
"result": "success"
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Data Residency
|
|
124
|
+
|
|
125
|
+
Region-specific deployment:
|
|
126
|
+
|
|
127
|
+
```json
|
|
128
|
+
{
|
|
129
|
+
"region": "us-east-1",
|
|
130
|
+
"dataResidency": {
|
|
131
|
+
"enabled": true,
|
|
132
|
+
"allowedRegions": ["us-east-1", "us-west-2"]
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Compliance Certifications
|
|
138
|
+
|
|
139
|
+
- **SOC 2 Type II**: Security controls
|
|
140
|
+
- **HIPAA**: Healthcare data protection
|
|
141
|
+
- **GDPR**: EU data protection
|
|
142
|
+
- **ISO 27001**: Information security
|
|
143
|
+
|
|
144
|
+
## Deployment Options
|
|
145
|
+
|
|
146
|
+
### Amazon Bedrock
|
|
147
|
+
|
|
148
|
+
Deploy via AWS Bedrock:
|
|
149
|
+
|
|
150
|
+
```json
|
|
151
|
+
{
|
|
152
|
+
"provider": "bedrock",
|
|
153
|
+
"region": "us-east-1",
|
|
154
|
+
"model": "anthropic.cursor-sonnet-4-5",
|
|
155
|
+
"credentials": {
|
|
156
|
+
"accessKeyId": "${AWS_ACCESS_KEY_ID}",
|
|
157
|
+
"secretAccessKey": "${AWS_SECRET_ACCESS_KEY}"
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Google Vertex AI
|
|
163
|
+
|
|
164
|
+
Deploy via GCP Vertex AI:
|
|
165
|
+
|
|
166
|
+
```json
|
|
167
|
+
{
|
|
168
|
+
"provider": "vertex",
|
|
169
|
+
"project": "company-project",
|
|
170
|
+
"location": "us-central1",
|
|
171
|
+
"model": "claude-sonnet-4-5",
|
|
172
|
+
"credentials": "/path/to/service-account.json"
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Self-Hosted
|
|
177
|
+
|
|
178
|
+
On-premises deployment:
|
|
179
|
+
|
|
180
|
+
**Docker:**
|
|
181
|
+
```bash
|
|
182
|
+
docker run -d \
|
|
183
|
+
-v /workspace:/workspace \
|
|
184
|
+
-e ANTHROPIC_API_KEY=$API_KEY \
|
|
185
|
+
anthropic/claude-code:latest
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
**Kubernetes:**
|
|
189
|
+
```yaml
|
|
190
|
+
apiVersion: apps/v1
|
|
191
|
+
kind: Deployment
|
|
192
|
+
metadata:
|
|
193
|
+
name: claude-code
|
|
194
|
+
spec:
|
|
195
|
+
replicas: 3
|
|
196
|
+
template:
|
|
197
|
+
spec:
|
|
198
|
+
containers:
|
|
199
|
+
- name: claude-code
|
|
200
|
+
image: anthropic/claude-code:latest
|
|
201
|
+
env:
|
|
202
|
+
- name: ANTHROPIC_API_KEY
|
|
203
|
+
valueFrom:
|
|
204
|
+
secretKeyRef:
|
|
205
|
+
name: claude-secrets
|
|
206
|
+
key: api-key
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### LLM Gateway
|
|
210
|
+
|
|
211
|
+
Integration with LiteLLM:
|
|
212
|
+
|
|
213
|
+
```json
|
|
214
|
+
{
|
|
215
|
+
"gateway": {
|
|
216
|
+
"enabled": true,
|
|
217
|
+
"url": "http://litellm-proxy:4000",
|
|
218
|
+
"apiKey": "${GATEWAY_API_KEY}"
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
## Monitoring & Analytics
|
|
224
|
+
|
|
225
|
+
### OpenTelemetry
|
|
226
|
+
|
|
227
|
+
Built-in telemetry support:
|
|
228
|
+
|
|
229
|
+
```json
|
|
230
|
+
{
|
|
231
|
+
"telemetry": {
|
|
232
|
+
"enabled": true,
|
|
233
|
+
"exporter": "otlp",
|
|
234
|
+
"endpoint": "http://otel-collector:4317",
|
|
235
|
+
"metrics": true,
|
|
236
|
+
"traces": true,
|
|
237
|
+
"logs": true
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Usage Analytics
|
|
243
|
+
|
|
244
|
+
Track team productivity metrics:
|
|
245
|
+
|
|
246
|
+
```bash
|
|
247
|
+
# Get usage report
|
|
248
|
+
claude analytics usage --start 2025-11-01 --end 2025-11-06
|
|
249
|
+
|
|
250
|
+
# Get cost report
|
|
251
|
+
claude analytics cost --group-by user
|
|
252
|
+
|
|
253
|
+
# Export metrics
|
|
254
|
+
claude analytics export --format csv > metrics.csv
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
**Metrics tracked:**
|
|
258
|
+
- Requests per user/project
|
|
259
|
+
- Token usage
|
|
260
|
+
- Tool invocations
|
|
261
|
+
- Session duration
|
|
262
|
+
- Error rates
|
|
263
|
+
- Cost per user/project
|
|
264
|
+
|
|
265
|
+
### Custom Dashboards
|
|
266
|
+
|
|
267
|
+
Build org-specific dashboards:
|
|
268
|
+
|
|
269
|
+
```python
|
|
270
|
+
from claude_code import Analytics
|
|
271
|
+
|
|
272
|
+
analytics = Analytics(api_key=API_KEY)
|
|
273
|
+
|
|
274
|
+
# Get metrics
|
|
275
|
+
metrics = analytics.get_metrics(
|
|
276
|
+
start="2025-11-01",
|
|
277
|
+
end="2025-11-06",
|
|
278
|
+
group_by="user"
|
|
279
|
+
)
|
|
280
|
+
|
|
281
|
+
# Create visualization
|
|
282
|
+
dashboard = analytics.create_dashboard(
|
|
283
|
+
metrics=metrics,
|
|
284
|
+
charts=["usage", "cost", "errors"]
|
|
285
|
+
)
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### Cost Management
|
|
289
|
+
|
|
290
|
+
Monitor and control API costs:
|
|
291
|
+
|
|
292
|
+
```json
|
|
293
|
+
{
|
|
294
|
+
"costControl": {
|
|
295
|
+
"enabled": true,
|
|
296
|
+
"budgets": {
|
|
297
|
+
"monthly": 10000,
|
|
298
|
+
"perUser": 500
|
|
299
|
+
},
|
|
300
|
+
"alerts": {
|
|
301
|
+
"threshold": 0.8,
|
|
302
|
+
"recipients": ["admin@company.com"]
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
## Network Configuration
|
|
309
|
+
|
|
310
|
+
### Proxy Support
|
|
311
|
+
|
|
312
|
+
HTTP/HTTPS proxy configuration:
|
|
313
|
+
|
|
314
|
+
```bash
|
|
315
|
+
export HTTP_PROXY=http://proxy.company.com:8080
|
|
316
|
+
export HTTPS_PROXY=http://proxy.company.com:8080
|
|
317
|
+
export NO_PROXY=localhost,127.0.0.1,company.internal
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Custom CA
|
|
321
|
+
|
|
322
|
+
Trust custom certificate authorities:
|
|
323
|
+
|
|
324
|
+
```bash
|
|
325
|
+
export NODE_EXTRA_CA_CERTS=/etc/ssl/certs/company-ca.crt
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
### Mutual TLS (mTLS)
|
|
329
|
+
|
|
330
|
+
Client certificate authentication:
|
|
331
|
+
|
|
332
|
+
```json
|
|
333
|
+
{
|
|
334
|
+
"mtls": {
|
|
335
|
+
"enabled": true,
|
|
336
|
+
"clientCert": "/path/to/client-cert.pem",
|
|
337
|
+
"clientKey": "/path/to/client-key.pem",
|
|
338
|
+
"caCert": "/path/to/ca-cert.pem"
|
|
339
|
+
}
|
|
340
|
+
}
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### IP Allowlisting
|
|
344
|
+
|
|
345
|
+
Restrict access by IP:
|
|
346
|
+
|
|
347
|
+
```json
|
|
348
|
+
{
|
|
349
|
+
"ipAllowlist": {
|
|
350
|
+
"enabled": true,
|
|
351
|
+
"addresses": [
|
|
352
|
+
"10.0.0.0/8",
|
|
353
|
+
"192.168.1.0/24",
|
|
354
|
+
"203.0.113.42"
|
|
355
|
+
]
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
## Data Governance
|
|
361
|
+
|
|
362
|
+
### Data Retention
|
|
363
|
+
|
|
364
|
+
Configure data retention policies:
|
|
365
|
+
|
|
366
|
+
```json
|
|
367
|
+
{
|
|
368
|
+
"dataRetention": {
|
|
369
|
+
"conversations": "30d",
|
|
370
|
+
"logs": "90d",
|
|
371
|
+
"metrics": "1y",
|
|
372
|
+
"backups": "7d"
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Data Encryption
|
|
378
|
+
|
|
379
|
+
Encryption at rest and in transit:
|
|
380
|
+
|
|
381
|
+
```json
|
|
382
|
+
{
|
|
383
|
+
"encryption": {
|
|
384
|
+
"atRest": {
|
|
385
|
+
"enabled": true,
|
|
386
|
+
"algorithm": "AES-256-GCM",
|
|
387
|
+
"keyManagement": "aws-kms"
|
|
388
|
+
},
|
|
389
|
+
"inTransit": {
|
|
390
|
+
"tlsVersion": "1.3",
|
|
391
|
+
"cipherSuites": ["TLS_AES_256_GCM_SHA384"]
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### PII Protection
|
|
398
|
+
|
|
399
|
+
Detect and redact PII:
|
|
400
|
+
|
|
401
|
+
```json
|
|
402
|
+
{
|
|
403
|
+
"piiProtection": {
|
|
404
|
+
"enabled": true,
|
|
405
|
+
"detectPatterns": ["email", "ssn", "credit_card"],
|
|
406
|
+
"action": "redact",
|
|
407
|
+
"auditLog": true
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
## High Availability
|
|
413
|
+
|
|
414
|
+
### Load Balancing
|
|
415
|
+
|
|
416
|
+
Distribute requests across instances:
|
|
417
|
+
|
|
418
|
+
```yaml
|
|
419
|
+
# HAProxy configuration
|
|
420
|
+
frontend claude_front
|
|
421
|
+
bind *:443 ssl crt /etc/ssl/certs/claude.pem
|
|
422
|
+
default_backend claude_back
|
|
423
|
+
|
|
424
|
+
backend claude_back
|
|
425
|
+
balance roundrobin
|
|
426
|
+
server claude1 10.0.1.10:8080 check
|
|
427
|
+
server claude2 10.0.1.11:8080 check
|
|
428
|
+
server claude3 10.0.1.12:8080 check
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### Failover
|
|
432
|
+
|
|
433
|
+
Automatic failover configuration:
|
|
434
|
+
|
|
435
|
+
```json
|
|
436
|
+
{
|
|
437
|
+
"highAvailability": {
|
|
438
|
+
"enabled": true,
|
|
439
|
+
"primaryRegion": "us-east-1",
|
|
440
|
+
"failoverRegions": ["us-west-2", "eu-west-1"],
|
|
441
|
+
"healthCheck": {
|
|
442
|
+
"interval": "30s",
|
|
443
|
+
"timeout": "5s"
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
### Backup & Recovery
|
|
450
|
+
|
|
451
|
+
Automated backup strategies:
|
|
452
|
+
|
|
453
|
+
```bash
|
|
454
|
+
# Configure backups
|
|
455
|
+
claude admin backup configure \
|
|
456
|
+
--schedule "0 2 * * *" \
|
|
457
|
+
--retention 30d \
|
|
458
|
+
--destination s3://backups/claude-code
|
|
459
|
+
|
|
460
|
+
# Manual backup
|
|
461
|
+
claude admin backup create
|
|
462
|
+
|
|
463
|
+
# Restore from backup
|
|
464
|
+
claude admin backup restore backup-20251106
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
## See Also
|
|
468
|
+
|
|
469
|
+
- Network configuration: https://docs.cursor.com/claude-code/network-config
|
|
470
|
+
- Security best practices: `references/best-practices.md`
|
|
471
|
+
- Monitoring setup: https://docs.cursor.com/claude-code/monitoring
|
|
472
|
+
- Compliance: https://docs.cursor.com/claude-code/legal-and-compliance
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# Getting Started with Cursor
|
|
2
|
+
|
|
3
|
+
Installation, authentication, and setup guide for Cursor.
|
|
4
|
+
|
|
5
|
+
## What is Cursor?
|
|
6
|
+
|
|
7
|
+
Cursor is Anthropic's agentic coding tool that lives in the terminal and helps turn ideas into code faster. Key features:
|
|
8
|
+
|
|
9
|
+
- **Agentic Capabilities**: Autonomous planning, execution, and validation
|
|
10
|
+
- **Terminal Integration**: Works directly in command line
|
|
11
|
+
- **IDE Support**: Extensions for VS Code and JetBrains IDEs
|
|
12
|
+
- **Extensibility**: Plugins, skills, slash commands, and MCP servers
|
|
13
|
+
- **Enterprise Ready**: SSO, sandboxing, monitoring, and compliance features
|
|
14
|
+
|
|
15
|
+
## Prerequisites
|
|
16
|
+
|
|
17
|
+
### System Requirements
|
|
18
|
+
- **Operating Systems**: macOS, Linux, or Windows (WSL2)
|
|
19
|
+
- **Runtime**: Node.js 18+ or Python 3.10+
|
|
20
|
+
- **API Key**: From Anthropic Console (console.anthropic.com)
|
|
21
|
+
|
|
22
|
+
### Getting API Key
|
|
23
|
+
1. Go to console.anthropic.com
|
|
24
|
+
2. Sign in or create account
|
|
25
|
+
3. Navigate to API Keys section
|
|
26
|
+
4. Generate new API key
|
|
27
|
+
5. Save key securely (cannot be viewed again)
|
|
28
|
+
|
|
29
|
+
## Installation
|
|
30
|
+
|
|
31
|
+
### Install via npm (Recommended)
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g @anthropic-ai/claude-code
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Install via pip
|
|
37
|
+
```bash
|
|
38
|
+
pip install claude-code
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Verify Installation
|
|
42
|
+
```bash
|
|
43
|
+
claude --version
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Authentication
|
|
47
|
+
|
|
48
|
+
### Method 1: Interactive Login
|
|
49
|
+
```bash
|
|
50
|
+
claude login
|
|
51
|
+
# Follow prompts to enter API key
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Method 2: Environment Variable
|
|
55
|
+
```bash
|
|
56
|
+
# Add to ~/.bashrc or ~/.zshrc
|
|
57
|
+
export ANTHROPIC_API_KEY=your_api_key_here
|
|
58
|
+
|
|
59
|
+
# Or set for single session
|
|
60
|
+
export ANTHROPIC_API_KEY=your_api_key_here
|
|
61
|
+
claude
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Method 3: Configuration File
|
|
65
|
+
Create `~/.cursor/config.json`:
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"apiKey": "your_api_key_here"
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Verify Authentication
|
|
73
|
+
```bash
|
|
74
|
+
claude "hello"
|
|
75
|
+
# Should respond without authentication errors
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## First Run
|
|
79
|
+
|
|
80
|
+
### Start Interactive Session
|
|
81
|
+
```bash
|
|
82
|
+
# In any directory
|
|
83
|
+
claude
|
|
84
|
+
|
|
85
|
+
# In specific project
|
|
86
|
+
cd /path/to/project
|
|
87
|
+
claude
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Run with Specific Task
|
|
91
|
+
```bash
|
|
92
|
+
claude "implement user authentication"
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Run with File Context
|
|
96
|
+
```bash
|
|
97
|
+
claude "explain this code" --file app.js
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Basic Usage
|
|
101
|
+
|
|
102
|
+
### Interactive Mode
|
|
103
|
+
```bash
|
|
104
|
+
$ claude
|
|
105
|
+
Cursor> help me create a React component
|
|
106
|
+
# Claude will plan and execute
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### One-Shot Mode
|
|
110
|
+
```bash
|
|
111
|
+
claude "add error handling to main.py"
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### With Additional Context
|
|
115
|
+
```bash
|
|
116
|
+
claude "refactor this function" --file utils.js --context "make it async"
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Understanding the Interface
|
|
120
|
+
|
|
121
|
+
### Session Start
|
|
122
|
+
```
|
|
123
|
+
Cursor v1.x.x
|
|
124
|
+
Working directory: /path/to/project
|
|
125
|
+
Model: claude-sonnet-4-5-20250929
|
|
126
|
+
|
|
127
|
+
Cursor>
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Tool Execution
|
|
131
|
+
Claude will show:
|
|
132
|
+
- Tool being used (Read, Write, Bash, etc.)
|
|
133
|
+
- Tool parameters
|
|
134
|
+
- Results or outputs
|
|
135
|
+
- Thinking/planning process (if enabled)
|
|
136
|
+
|
|
137
|
+
### Session End
|
|
138
|
+
```bash
|
|
139
|
+
# Type Ctrl+C or Ctrl+D
|
|
140
|
+
# Or type 'exit' or 'quit'
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Common First Commands
|
|
144
|
+
|
|
145
|
+
### Explore Codebase
|
|
146
|
+
```bash
|
|
147
|
+
claude "explain the project structure"
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Run Tests
|
|
151
|
+
```bash
|
|
152
|
+
claude "run the test suite"
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Fix Issues
|
|
156
|
+
```bash
|
|
157
|
+
claude "fix all TypeScript errors"
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Add Feature
|
|
161
|
+
```bash
|
|
162
|
+
claude "add input validation to the login form"
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
## Directory Structure
|
|
166
|
+
|
|
167
|
+
Cursor creates `.cursor/` in your project:
|
|
168
|
+
|
|
169
|
+
```
|
|
170
|
+
project/
|
|
171
|
+
├── .cursor/
|
|
172
|
+
│ ├── settings.json # Project-specific settings
|
|
173
|
+
│ ├── commands/ # Custom slash commands
|
|
174
|
+
│ ├── skills/ # Custom skills
|
|
175
|
+
│ ├── hooks.json # Hook configurations
|
|
176
|
+
│ └── mcp.json # MCP server configurations
|
|
177
|
+
└── ...
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Next Steps
|
|
181
|
+
|
|
182
|
+
### Learn Slash Commands
|
|
183
|
+
```bash
|
|
184
|
+
# See available commands
|
|
185
|
+
/help
|
|
186
|
+
|
|
187
|
+
# Try common workflows
|
|
188
|
+
/cook implement feature X
|
|
189
|
+
/fix:fast bug in Y
|
|
190
|
+
/test
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Create Custom Skills
|
|
194
|
+
See `references/agent-skills.md` for creating project-specific skills.
|
|
195
|
+
|
|
196
|
+
### Configure MCP Servers
|
|
197
|
+
See `references/mcp-integration.md` for connecting external tools.
|
|
198
|
+
|
|
199
|
+
### Set Up Hooks
|
|
200
|
+
See `references/hooks-and-plugins.md` for automation.
|
|
201
|
+
|
|
202
|
+
### Configure Settings
|
|
203
|
+
See `references/configuration.md` for customization options.
|
|
204
|
+
|
|
205
|
+
## Quick Troubleshooting
|
|
206
|
+
|
|
207
|
+
### Authentication Issues
|
|
208
|
+
```bash
|
|
209
|
+
# Re-login
|
|
210
|
+
claude logout
|
|
211
|
+
claude login
|
|
212
|
+
|
|
213
|
+
# Verify API key is set
|
|
214
|
+
echo $ANTHROPIC_API_KEY
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Permission Errors
|
|
218
|
+
```bash
|
|
219
|
+
# Check file permissions
|
|
220
|
+
ls -la ~/.cursor
|
|
221
|
+
|
|
222
|
+
# Fix ownership
|
|
223
|
+
sudo chown -R $USER ~/.cursor
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Installation Issues
|
|
227
|
+
```bash
|
|
228
|
+
# Clear npm cache
|
|
229
|
+
npm cache clean --force
|
|
230
|
+
|
|
231
|
+
# Reinstall
|
|
232
|
+
npm uninstall -g @anthropic-ai/claude-code
|
|
233
|
+
npm install -g @anthropic-ai/claude-code
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### WSL2 Issues (Windows)
|
|
237
|
+
```bash
|
|
238
|
+
# Ensure WSL2 is updated
|
|
239
|
+
wsl --update
|
|
240
|
+
|
|
241
|
+
# Check Node.js version in WSL
|
|
242
|
+
node --version # Should be 18+
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
## Getting Help
|
|
246
|
+
|
|
247
|
+
- **Documentation**: https://docs.cursor.com/claude-code
|
|
248
|
+
- **GitHub Issues**: https://github.com/anthropics/claude-code/issues
|
|
249
|
+
- **Support**: support.cursor.com
|
|
250
|
+
- **Community**: discord.gg/anthropic
|
|
251
|
+
|
|
252
|
+
For detailed troubleshooting, see `references/troubleshooting.md`.
|