Skip to content
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

boxcli: add clean command #2341

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

DerArkeN
Copy link
Contributor

@DerArkeN DerArkeN commented Oct 9, 2024

Summary

This if a first draft for #2335, I am not sure about the behaviour or features of the command yet so I only added basic functionality.
The issue also mentioned deleting files like .envrc, I didn't include this yet since these files might be generated by a user instead of the devbox, maybe this should be added by an optional parameter? or are generated files tracked?
I also wasn't sure if the clean command should exit the devbox shell or not. In case it should, is the pid of the devbox saved anywhere so it can be killed, or is there a better way to do so?

How was it tested?

  • devbox init
  • devbox add go
  • devbox shell
  • devbox clean

=> expected result: .devbox, devbox.lock are deleted and the user remains in the shell.

I also included a test, but I can't test it because of #2342 so it might fail.

Edit

The behaviour is as following now:
running devbox clean deletes .devbox and devbox.lock
running devbox clean --hard asks for a confirmation and also deletes devbox.json

@DerArkeN DerArkeN marked this pull request as ready for review October 9, 2024 20:18
@DerArkeN
Copy link
Contributor Author

I added the hard flag now to also delete the devbox.json file, I don't quite like the naming yet and am open for suggestions

@trya2l
Copy link

trya2l commented Oct 11, 2024

Hi, what about --all, or --force ?

@DerArkeN
Copy link
Contributor Author

All might be an option. Imo force is something else, it means perform an action even though it might break things, an doesn't fit the action here.

@adamdicarlo0
Copy link
Contributor

How about devbox uninit or devbox eject?

A command named clean deleting devbox.json and devbox.lock would be very surprising to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants