Skip to content

feat: flox pull --copy in sharing guide #29

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 2 commits into from
Sep 23, 2024
Merged

Conversation

ghudgins
Copy link
Contributor

Adds flox pull --copy to sharing guide

@floxbot floxbot added the documentation Improvements or additions to documentation label Sep 20, 2024
Copy link

Copy link

Copy link
Contributor

@jennymahmoudi jennymahmoudi left a comment

Choose a reason for hiding this comment

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

This is great!

Where do you think the other use case of pull --copy should go? When you want to sever the connection to an env you've pushed (and possibly deleted or renamed). Part of the man page for flox pull for sure, but I'm not sure it fits on the sharing guide. Wdyt?


### Pulling a remote environment without connecting to FloxHub

Sometimes you may want to create a FloxHub remote environment that serves as a template starting point for your project but will grow to have different environment definitions across multiple projects.
Copy link
Contributor

Choose a reason for hiding this comment

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

Sometimes you may want to create a FloxHub remote environment that serves as a template starting point

Depending on who you address i think it might find a broader audience if you said

"Sometimes you want to use a FloxHub remote environment as a template, a starting point for your project."

Sometimes you may want to create a FloxHub remote environment that serves as a template starting point for your project but will grow to have different environment definitions across multiple projects.
In this cases, you may want to [`flox pull --copy`][flox_pull] instead of [`flox pull`][flox_pull].

[`flox pull --copy`][flox_pull], like [`flox pull`][flox_pull], will create a `.flox` folder to the directory you are in. However, this environment will **not be linked to FloxHub**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[`flox pull --copy`][flox_pull], like [`flox pull`][flox_pull], will create a `.flox` folder to the directory you are in. However, this environment will **not be linked to FloxHub**.
[`flox pull --copy`][flox_pull], like [`flox pull`][flox_pull], will create a `.flox` folder to the directory you are in. However, this environment will **not be linked to FloxHub**, instead it will be entirely local as if created from scratch using [`flox init`][flox_init] and can be pushed under a new name or owner.

or something similar, i think "not be linked to floxhub" is not making the implications obvious

@ghudgins ghudgins merged commit 3b67b6f into preview Sep 23, 2024
3 checks passed
@ghudgins ghudgins deleted the f/flox-pull-copy branch September 23, 2024 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants