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
Remove unecessary warning in README. Since the tool isn't stable (not
1.0.0 yet) I think I'm ok with just making breaking changes. I can note
this in the next release, but I think so far I'm my only customer.
Copy file name to clipboardExpand all lines: README.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@
4
4
5
5
See the [design documentation](./docs/design.md) for more details on some of the differences between `embd` and `beman-submodule` as well as why those decisions were made.
6
6
7
-
> **Breaking change:**`embd` used to store one config file for the whole project, at a root-level `.embd/embd.toml` (or, in older versions, `config.toml` + `embd.lock`). It now stores one `.embd` file per embedded folder instead — see [Configuration File](./docs/design.md#configuration-file). If `embd` detects a project still using the old root-level `.embd/` layout, it will now error instead of silently reporting nothing. There is no automated migration; convert existing entries to the new per-folder `.embd` file layout by hand.
8
-
9
7
## Installation
10
8
11
9
Install the latest published release from [crates.io](https://crates.io/crates/embd-cli):
|`add`| Add a new embedded repo to the project. |`folder`: Specify what subdirectory to put embed in. \n `allow-untracked`: Allow untracked files in the embed directory. \n `link`: The link to the project to include \n `rev`: Specify the commit,tag or branch to pull \n `include`: Glob patterns to include \n `exclude`: Glob patterns to exclude |
|`add`|Add a new embedded repo to the project.|`folder`: Specify what subdirectory to put embed in. \n `allow-untracked`: Allow untracked files in the embed directory. \n `link`: The link to the project to include \n `rev`: Specify the commit,tag or branch to pull \n `include`: Glob patterns to include \n `exclude`: Glob patterns to exclude |
22
22
|`update`| Update all embeds to match their pinned config. |`rev`: Specify the commit, tag or branch to advance to \n `force`: Overwrite any local modification \n `overwrite`: Delete all untracked files (requries `force`) \n `quiet`: Print summaries, not each file updates. |
23
-
|`status`| Show the status of all embeds. |`quiet`: Should summaries per embed, not per file. |
23
+
|`status`|Show the status of all embeds.|`quiet`: Should summaries per embed, not per file. |
24
24
25
25
### Configuration File
26
26
27
-
`embd` stores one configuration file per embed, named `.embd`, inside the embedded folder itself — mirroring how [beman-submodule](https://github.com/bemanproject/beman-submodule) stores a `.beman_submodule` file inside each submodule it manages. There's no project-wide config file; `embd` discovers embeds by walking the project tree for `.embd` files.
27
+
`embd` stores one configuration file per embed, named `.embd`, inside the embedded folder itself. This mirrors how [beman-submodule](https://github.com/bemanproject/beman-submodule) stores a `.beman_submodule` file inside each submodule it manages. There's no project-wide config file; `embd` discovers embeds by walking the project tree for `.embd` files.
28
28
29
29
Each file has a `metadata` table with the remote repository URL, commit, and include/exclude filters, plus a `files` table of sha256 hashes per tracked file, used to detect local drift without re-pulling or cloning files from the remote. The embed's folder isn't stored in the file — it's implied by the file's own location.
0 commit comments