Skip to content

Add MIT license and shorten the README - #33

Merged
dipjyotimetia merged 1 commit into
mainfrom
cursor/readme-license-polish-b45e
Nov 18, 2026
Merged

dipjyotimetia merged 1 commit into
mainfrom
cursor/readme-license-polish-b45e

Conversation

@dipjyotimetia

Copy link
Copy Markdown
Owner

Summary

Adds an MIT license and shortens the README. The top of the page is now the pitch, install steps, a quick start, and the AI providers the CLI actually calls. Longer feature write-ups moved into docs/ and are linked from the README.

License: this adds the MIT License, copyright 2026 Dipjyoti Metia. MIT is the license already used by restura, HybridTestFramework, and deep-agent-action. If you want a different license, the LICENSE file can be replaced before merge. This pull request is not merged.

The release badge now points at https://github.com/dipjyotimetia/JARVIS/actions/workflows/release.yml. Both the JARVIS and jarvis badge URLs currently return the same SVG (HTTP 200). The badge uses the repository's canonical name.

Providers checked in pkg/engine/llm/client.go: OpenAI, Anthropic, Google Gemini, and Ollama. If LLM_PROVIDER is unset, detection order is OPENAI_API_KEY, then ANTHROPIC_API_KEY, then GOOGLE_API_KEY, otherwise Ollama.

A stray fence in docs/example.md opened a code block early, so the "Generate Test Code" heading and the # shell comments under it were rendered as plain code. That fence is removed. Shell comments in the README were already inside fenced blocks and did not render as headings.

These claims from the old README were not copied forward, because the code does not expose them as commands:

  • Pact contract generation (generate-contracts is not registered)
  • Jira and Confluence as user-facing integrations (the packages exist; there is no CLI command)
  • A language template system

docs/commands.md includes analyze diff and update, which are registered in cmd/root.go and were missing from the old command tree.

Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • 💥 Breaking change
  • 📝 Documentation update

Testing

  • Compared commands, flags, and provider defaults with cmd/root.go, pkg/engine/llm/client.go, and the command implementations.
  • Rendered the README and docs/example.md with GitHub's Markdown API. Shell comments stay inside code fences, and "Generate Test Code" renders as a heading.
  • Requested both badge URL casings. Both return HTTP 200 and the same image. The README uses JARVIS.

Checklist

  • Self-reviewed code
  • Added/updated tests
  • Updated documentation (if needed)
  • No new warnings generated
  • Dependent changes merged
Open in Web Open in Cursor 

Move the longer feature guides into docs/, point the release badge at
the JARVIS repository name, and close a stray fence that kept a heading
and its shell examples out of the rendered docs.

Co-authored-by: Dipjyoti Metia <dipjyotimetia@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

🧪 Test Summary Report

📊 Summary

  • 🧪 Total Tests: 69
  • ✅ Passed: 69 (100.0%)
  • ❌ Failed: 0
  • ⏭️ Skipped: 0
  • ⏱️ Total Duration: 3.23s

Pass Rate Progress

[████████████████████] 100.0%

🎯 Test Status

🎉 Status 🎉

✨ Excellent! All tests passed successfully!


📝 Test Results

Test Status Duration Details
TestAPIValidator ✅ PASS 0.003s
4 subtests
SubtestStatusDuration
InvalidMethod✅ PASS0.000s
InvalidResponse✅ PASS0.000s
ValidRequest✅ PASS0.000s
ValidResponse✅ PASS0.000s
TestAddFault ✅ PASS 0.000s -
TestAuthMiddleware ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Invalid_credentials✅ PASS0.000s
No_credentials✅ PASS0.000s
Valid_credentials✅ PASS0.000s
TestCORSMiddleware ✅ PASS 0.000s
2 subtests
SubtestStatusDuration
Allowed_origin✅ PASS0.000s
OPTIONS_request✅ PASS0.000s
TestCalculateBaseline ✅ PASS 0.000s
1 subtests
SubtestStatusDuration
Empty_metrics✅ PASS0.000s
TestCalculateMeanStdDev ✅ PASS 0.000s
2 subtests
SubtestStatusDuration
Empty_values✅ PASS0.000s
Single_value✅ PASS0.000s
TestCalculatePercentiles ✅ PASS 0.000s
2 subtests
SubtestStatusDuration
Empty_values✅ PASS0.000s
Single_value✅ PASS0.000s
TestChain ✅ PASS 0.000s -
TestCheckAnomaly ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Anomaly_detected_-high_latency✅ PASS0.000s
No_anomaly-normal_latency✅ PASS0.000s
No_baseline-_no_anomaly✅ PASS0.000s
TestClearFaults ✅ PASS 0.000s -
TestConcurrentAccess ✅ PASS 0.000s -
TestContains ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Empty_slice✅ PASS0.000s
Found✅ PASS0.000s
Not_found✅ PASS0.000s
TestCreatePresetFaults ✅ PASS 0.000s
4 subtests
SubtestStatusDuration
CreateDisconnectFault✅ PASS0.000s
CreateErrorFault✅ PASS0.000s
CreateLatencyFault✅ PASS0.000s
CreateThrottleFault✅ PASS0.000s
TestDatabaseConcurrency ✅ PASS 0.020s -
TestDatabaseErrorHandling ✅ PASS 0.003s
2 subtests
SubtestStatusDuration
Detail_handler_database_error✅ PASS0.000s
List_handler_database_error✅ PASS0.000s
TestDatabaseFailure ✅ PASS 0.001s -
TestDatabaseIndexes ✅ PASS 0.005s -
TestDurationStatsEdgeCases ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
No_data✅ PASS0.000s
Single_measurement✅ PASS0.000s
Zero_duration✅ PASS0.000s
TestEnableDisable ✅ PASS 0.000s -
TestFaultDuration ✅ PASS 0.060s -
TestGenerateReport ✅ PASS 0.000s -
TestGenerateSelfSignedCert ✅ PASS 0.020s -
TestGenerateSelfSignedCert_InvalidPath ✅ PASS 0.000s -
TestGetActiveFaults ✅ PASS 0.000s -
TestGetAllDurationStats ✅ PASS 0.000s -
TestGetAllStatusCodes ✅ PASS 0.000s -
TestGetStats ✅ PASS 0.000s -
TestGetSummary ✅ PASS 0.000s -
TestGetTargetURL ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Match_first_route✅ PASS0.000s
Match_second_route✅ PASS0.000s
Use_default_for_non-matching_path✅ PASS0.000s
TestHandleIndex ✅ PASS 0.004s -
TestHandleTransactionDetail ✅ PASS 0.003s
5 subtests
SubtestStatusDuration
Empty_ID✅ PASS0.000s
Get_HTTP_transaction✅ PASS0.000s
Get_WebSocket_transaction✅ PASS0.000s
Invalid_path✅ PASS0.000s
Non-existent_transaction✅ PASS0.000s
TestHandleTransactionsList ✅ PASS 0.005s
11 subtests
SubtestStatusDuration
All_transactions✅ PASS0.000s
Complex_filter✅ PASS0.000s
Filter_by_HTTP_protocol✅ PASS0.000s
Filter_by_URL✅ PASS0.000s
Filter_by_WebSocket_protocol✅ PASS0.000s
Filter_by_method✅ PASS0.000s
Invalid_pagination_params✅ PASS0.000s
Large_pageSize✅ PASS0.000s
Pagination_-_page_1,size_2✅ PASS0.000s
Pagination-_page_2,size_2✅ PASS0.000s
Pagination-_page_3,_size_2✅ PASS0.000s
TestHealthStatus ✅ PASS 0.000s
5 subtests
SubtestStatusDuration
Critical✅ PASS0.000s
Critical_overrides_degraded✅ PASS0.000s
Degraded✅ PASS0.000s
Healthy✅ PASS0.000s
Warning✅ PASS0.000s
TestIncrementErrors ✅ PASS 0.000s -
TestIncrementRequests ✅ PASS 0.000s -
TestInitialize ✅ PASS 0.990s -
TestInjectCorrupt ✅ PASS 0.000s -
TestInjectDisconnect ✅ PASS 0.000s -
TestInjectError ✅ PASS 0.000s -
TestInjectLatency ✅ PASS 0.050s -
TestInjectThrottle ✅ PASS 0.010s -
TestJarvisError ✅ PASS 0.000s
6 subtests
SubtestStatusDuration
Basic_error_creation✅ PASS0.000s
Error_code_checking✅ PASS0.000s
Error_with_context✅ PASS0.000s
Error_wrapping✅ PASS0.000s
JSON_serialization✅ PASS0.000s
Predefined_constructors✅ PASS0.000s
TestLoadConfig ✅ PASS 0.001s
9 subtests
SubtestStatusDuration
Both_recording_and_replay_mode✅ PASS0.000s
Invalid_target_routes_-missing_path_prefix✅ PASS0.000s
Invalid_target_routes-_path_prefix_without_leading_slash✅ PASS0.000s
Missing_HTTP_port✅ PASS0.000s
Missing_target_URL✅ PASS0.000s
TLS_enabled_without_cert✅ PASS0.000s
Valid_TLS_config✅ PASS0.000s
Valid_configuration✅ PASS0.000s
Valid_target_routes✅ PASS0.000s
TestLoadSaveBaseline ✅ PASS 0.000s -
TestLoggingMiddleware ✅ PASS 0.001s -
TestMatchesPattern ✅ PASS 0.000s
7 subtests
SubtestStatusDuration
Exact_match✅ PASS0.000s
No_wildcard_no_match✅ PASS0.000s
Prefix_wildcard_match✅ PASS0.000s
Prefix_wildcard_no_match✅ PASS0.000s
Suffix_wildcard_match✅ PASS0.000s
Suffix_wildcard_no_match✅ PASS0.000s
Wildcard_all✅ PASS0.000s
TestMetricsMiddleware ✅ PASS 0.000s -
TestMinSamplesRequirement ✅ PASS 0.000s -
TestNewChaosEngine ✅ PASS 0.000s -
TestNewMetrics ✅ PASS 0.000s -
TestNewRegressionDetector ✅ PASS 0.000s -
TestNewUIHandler ✅ PASS 1.020s -
TestNormalizePathForSpec ✅ PASS 0.000s -
TestPercentageConversion ✅ PASS 0.000s -
TestRateLimitMiddleware ✅ PASS 0.010s -
TestRecordDuration ✅ PASS 0.000s -
TestRecordStatusCode ✅ PASS 0.000s -
TestRecordingMiddleware ✅ PASS 0.000s -
TestRecoveryMiddleware ✅ PASS 0.000s -
TestRegisterRoutes ✅ PASS 0.010s -
TestRemoveFault ✅ PASS 0.000s -
TestRemoveFaultInvalidIndex ✅ PASS 0.000s -
TestRequestIDMiddleware ✅ PASS 0.000s
2 subtests
SubtestStatusDuration
Generate_new_request_ID✅ PASS0.000s
Use_existing_request_ID✅ PASS0.000s
TestReset ✅ PASS 0.000s -
TestSeverityClassification ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Critical_-7_std_devs✅ PASS0.000s
High-4.5_std_devs✅ PASS0.000s
Medium-_2.5_std_devs✅ PASS0.000s
TestShouldInjectFault ✅ PASS 0.000s
3 subtests
SubtestStatusDuration
Disabled_engine✅ PASS0.000s
Matching_path✅ PASS0.000s
Non-matching_path✅ PASS0.000s
TestStartHTTPProxy_PassthroughMode ✅ PASS 1.000s -
TestTrafficRecordStorage ✅ PASS 0.010s
6 subtests
SubtestStatusDuration
QueryByID✅ PASS0.000s
QueryByMethodAndURL✅ PASS0.000s
QueryBySession✅ PASS0.000s
QueryWebSocketByConnectionID✅ PASS0.000s
QueryWebSocketMessagesByDirection✅ PASS0.000s
QueryWebSocketMessagesByType✅ PASS0.000s
TestUpdateBaseline ✅ PASS 0.000s -

⏱️ Test Durations

⚡ Click to expand test durations
Test Duration
TestNewUIHandler 1.020s █████████████████████████
TestStartHTTPProxy_PassthroughMode 1.000s ████████████████████████
TestInitialize 0.990s ████████████████████████
TestFaultDuration 0.060s █
TestInjectLatency 0.050s █
TestGenerateSelfSignedCert 0.020s █
TestDatabaseConcurrency 0.020s █
TestRegisterRoutes 0.010s █
TestTrafficRecordStorage 0.010s █
TestRateLimitMiddleware 0.010s █
TestInjectThrottle 0.010s █
TestDatabaseIndexes 0.005s █
TestHandleTransactionsList 0.005s █
TestHandleIndex 0.004s █
TestAPIValidator 0.003s █


View Workflow Run

Report generated at: 2026-11-16T07:39:56Z

View details for all test jobs

This is a combined report summary. See individual job comments for detailed reports or check the workflow run.

@dipjyotimetia
dipjyotimetia merged commit c2c1cc9 into main Nov 18, 2026
6 of 7 checks passed
@dipjyotimetia
dipjyotimetia deleted the cursor/readme-license-polish-b45e branch November 18, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants