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
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
-
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
-
21
23
## Usage
22
24
Foreman downloads tools from GitHub and references them by their `user/repo` name, like `rojo-rbx/foreman`.
23
25
26
+
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (usually `~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
27
+
28
+
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
29
+
24
30
### System Tools
25
31
To start using Foreman to manage your system's default tools, create the file `~/.foreman/foreman.toml`.
26
32
@@ -52,7 +58,7 @@ When inside this directory, the `remodel` command will run the latest 0.6.x rele
52
58
### Authentication
53
59
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
60
55
-
Open `~/.foreman/auth.toml` after Foreman has run at least once to see instructions on how to set this up.
61
+
Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.
56
62
57
63
## Troubleshooting
58
64
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.
0 commit comments