Repository navigation
Add MIT license and shorten the README - #33
Merged
Merged
Conversation
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>
🧪 Test Summary Report📊 Summary
Pass Rate Progress
🎯 Test Status
📝 Test Results
⏱️ Test Durations⚡ Click to expand test durations
Report generated at: 2026-11-16T07:39:56Z View details for all test jobsThis is a combined report summary. See individual job comments for detailed reports or check the workflow run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, anddeep-agent-action. If you want a different license, theLICENSEfile 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 theJARVISandjarvisbadge 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. IfLLM_PROVIDERis unset, detection order isOPENAI_API_KEY, thenANTHROPIC_API_KEY, thenGOOGLE_API_KEY, otherwise Ollama.A stray fence in
docs/example.mdopened 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:
generate-contractsis not registered)docs/commands.mdincludesanalyze diffandupdate, which are registered incmd/root.goand were missing from the old command tree.Type of Change
Testing
cmd/root.go,pkg/engine/llm/client.go, and the command implementations.docs/example.mdwith GitHub's Markdown API. Shell comments stay inside code fences, and "Generate Test Code" renders as a heading.JARVIS.Checklist