Skip to content

Docs - Add CLI reference section #105

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.

Sign up for GitHub

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

Jump to bottom
Closed
bfops opened this issue Nov 8, 2024 · 5 comments
Closed

Docs - Add CLI reference section #105

bfops opened this issue Nov 8, 2024 · 5 comments
Assignees
@bfops

Comments

@bfops
Copy link
Collaborator

bfops commented Nov 8, 2024

No description provided.

@gefjon
Copy link
Contributor

gefjon commented Jan 24, 2025

Can we generate this from spacetime --help?

@bfops
Copy link
Collaborator Author

bfops commented Jan 27, 2025

Any prose we add to explain these commands more clearly should ideally be added into the CLI help itself (and then we do what @gefjon says)

@bfops bfops self-assigned this Jan 27, 2025
@bfops
Copy link
Collaborator Author

bfops commented Feb 18, 2025

There is a clap-markdown package that seems like what we'd use, at least as an 80/20 for now.

CLI PR adding it: clockworklabs/SpacetimeDB#2276
Docs PR: #168

@bfops
Copy link
Collaborator Author

bfops commented Feb 18, 2025 •
edited
Loading

It doesn't do well with the multi-line help texts for some commands. We may want to tweak that help text.

(Edit: Created clockworklabs/SpacetimeDB#2277)

@bfops bfops mentioned this issue Feb 18, 2025
Merged
2 tasks
@bfops
Copy link
Collaborator Author

bfops commented Feb 19, 2025

All PRs are merged

@bfops bfops closed this as completed Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bfops bfops

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bfops @gefjon