Skip to content

Document CLI #1962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2025
Merged

Document CLI #1962

merged 3 commits into from
Mar 25, 2025

Conversation

jmthomas
Copy link
Member

closes #1933

@jmthomas jmthomas requested a review from ryanmelt March 22, 2025 22:17
@@ -79,7 +79,7 @@ def print_usage
puts " cli bridgesetup CONFIG_FILENAME # Create a default config file"
puts " cli pkginstall PKGFILENAME SCOPE # Install loaded package (Ruby gem or python package)"
puts " cli pkguninstall PKGFILENAME SCOPE # Uninstall loaded package (Ruby gem or python package)"
puts " cli rubysloc # Counts Ruby SLOC recursively. Run with --help for more info."
puts " cli rubysloc # DEPRECATED: Please use scc (https://github.com/boyter/scc)"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should support because scc is so much better and we don't even support Python

@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 1
Copy link
Member Author

@jmthomas jmthomas Mar 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved this to 1 because key-concepts is important to read before installation. It's just the order in the drop down ... no links have changed.

Copy link

codecov bot commented Mar 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.65%. Comparing base (fe1da82) to head (a36548e).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1962      +/-   ##
==========================================
- Coverage   76.68%   76.65%   -0.03%     
==========================================
  Files         628      628              
  Lines       46541    46547       +6     
  Branches      755      755              
==========================================
- Hits        35688    35679       -9     
- Misses      10770    10785      +15     
  Partials       83       83              
Flag Coverage Δ
python 84.10% <ø> (-0.09%) ⬇️
ruby-api 48.41% <ø> (ø)
ruby-backend 82.53% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

```bash
% openc3.sh cli load openc3-cosmos-test-1.0.0.gem
Installing openc3-cosmos-test-1.0.0.gem
Successfully installed openc3-cosmos-test-1.0.0.gem
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a copy and paste error but I had issues running load and list that might need an update before merging.

@jmthomas jmthomas requested a review from ryan-pratt March 25, 2025 15:51
@jmthomas jmthomas merged commit 934ee29 into main Mar 25, 2025
18 of 19 checks passed
@jmthomas jmthomas deleted the cli branch March 25, 2025 18:51
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.

Create CLI docs page
2 participants