You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Version number chosen so that Foreman can take over the [foreman](https://crates.io/crates/foreman) crate on crates.io and leave existing versions alone.
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (`~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
18
18
19
-
It's recommended that you add `~/.foreman/bin` to your `PATH`.
19
+
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
20
20
21
21
## Usage
22
22
Foreman downloads tools from GitHub and references them by their `user/repo` name, like `rojo-rbx/foreman`.
23
23
24
24
### System Tools
25
-
To start using Foreman to manage your system's default tools, which will be used unless a project overrides them, create the file `~/.foreman/foreman.toml`.
25
+
To start using Foreman to manage your system's default tools, create the file `~/.foreman/foreman.toml`.
26
26
27
27
A Foreman config that lists Rojo could look like:
28
28
@@ -31,7 +31,7 @@ A Foreman config that lists Rojo could look like:
31
31
rojo = { source = "rojo-rbx/rojo", version = "0.5.0" }
32
32
```
33
33
34
-
Run `foreman install` from any directory to have Foreman pick up and install any tools listed in your system's Foreman config.
34
+
Run `foreman install` from any directory to have Foreman pick up and install the tools listed in your system's Foreman config.
35
35
36
36
Now, if you run `rojo` inside of a directory that doesn't specify its own version of Rojo, Foreman will run the most recent 0.5.x release for you!
37
37
@@ -49,10 +49,15 @@ Run `foreman install` to tell Foreman to install any new binaries from this conf
49
49
50
50
When inside this directory, the `remodel` command will run the latest 0.6.x release of Remodel installed on your system.
51
51
52
+
### Authentication
53
+
To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
54
+
55
+
Open `~/.foreman/auth.toml` after Foreman has run at least once to see instructions on how to set this up.
56
+
52
57
## Troubleshooting
53
-
Foreman is a super early tool and has problems. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.
58
+
Foreman is a work in progress tool and has some known issues. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.
54
59
55
-
If you have issues with configuration, try deleting `~/.foreman` to start from scratch. This directory contains all of Foreman's installed tools and configuration.
60
+
If you have issues with configuration, you can delete `~/.foreman` to delete all cached data and start from scratch. This directory contains all of Foreman's installed tools and configuration.
56
61
57
62
## License
58
63
Foreman is available under the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for details.
0 commit comments