Skip to content

[docs]: update limactl installation steps #2703

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

Open
1 task done
chirag-ghosh opened this issue May 1, 2025 · 5 comments · May be fixed by keploy/docs#520
Open
1 task done

[docs]: update limactl installation steps #2703

chirag-ghosh opened this issue May 1, 2025 · 5 comments · May be fixed by keploy/docs#520
Labels
docs Documentation Improvements or additions to documentation

Comments

@chirag-ghosh
Copy link
Contributor

👀 Is there an existing issue for this?

  • I have searched and didn't find similar issue

💭 Description

The documentation for installing lima on MacOS is outdated (and in places wrong)

For example this step for installing a linux flavour is wrong and outdated.
The correct way to install a linux flavour (in this case debian) in lima is limactl create template://debian-12.

After that we dont need to connect to host from a code editor to be able to access it. A far easier way is to

  1. directly start the instance using limactl start debian-12
  2. enter the shell using limactl shell debian-12.

I want to update this steps in the docs so that other MacOS users can be benefitted. If the maintainers are aligned, I will work on updating the docs.

💻 Repository

docs

@chirag-ghosh chirag-ghosh added the Documentation Improvements or additions to documentation label May 1, 2025
@github-actions github-actions bot added the docs label May 1, 2025
@Achanandhi-M
Copy link
Contributor

Thanks @chirag-ghosh for pointing this out!

You're absolutely right the documentation for installing Lima on macOS is outdated, and your suggested corrections are spot on. Really appreciate you taking the time to not only identify the issue but also provide a clear and updated approach. This will definitely help many macOS users.

We’d love for you to contribute and update the docs! Feel free to go ahead with the changes and Looking forward to your contribution!

@Shreya2619
Copy link

Hi, I’m a Keploy Fellow and would like to work on this issue. I’ll go ahead and raise a PR shortly.

@chirag-ghosh
Copy link
Contributor Author

Hey @Shreya2619 thank you for the initiative. I know it's a bit late. I actually have the changes ready in my local just didn't get time to create the pull request. Do you mind waiting for a day in which case I'll make the PR and you can review?

@Shreya2619
Copy link

@chirag-ghosh Sure, no problem! I’ll wait for your PR and will be happy to review it once it's up. Let me know if you need any help with anything.

@chirag-ghosh chirag-ghosh linked a pull request May 20, 2025 that will close this issue
6 tasks
@chirag-ghosh
Copy link
Contributor Author

@Shreya2619 please review: keploy/docs#520
Thanks for the patience

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants