solidiquis / erdtree Goto Github PK

The asset for windows wasn't released in v1.8.1.

https://github.com/solidiquis/erdtree/releases/tag/v1.8.1

The performance of this tools is great! Amazing~

If a sort option for this command can be added. It would be better. In many cases, we might want to find the largest file or directory. Sort function can save the time for users to check from top to button.

For example:

OPTIONS:

……
-s: Sorted by file size

In tree, -L is used for specifying the depth of the tree. Currently -L flag is not used by et, so can et use both -L and -l for the level to match the convention?

Hi,
The glob option covers most cases but not all.
If i could use erdtree in combination with fd, the following would be possible
fd -e rs '^hel[lL]o' | et

Thanks for this great tool !!!

The et command works fine - except in my home directory:

thread 'main' panicked at 'called `Option::unwrap()` on a `None` value', src/fs/erdtree/node.rs:271:28
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

The only difference I can see is that my home directory has links from other directories. Like this:

lrwxrwxrwx@   19 dave dave 26 Feb  2022 Documents -> /foo/Documents
lrwxrwxrwx@   16 dave dave 10 Jan  2022 Downloads -> /blah/Downloads

Any other ideas? Let me know if you require additional information. Using version 1.20.

backtrace.txt

Ultimately the goal is to allow WalkParallel to do a complete traversal so that we can get comprehensive information about disk usage. Globbing/filtering/ordering and the like should happen after the fact.

Seems similar to #71.
I tried it on the latest version, 0aa59d7.

The -p options is used to exclude files or directories with some specified prefixes. But if some hidden or system files start with "." prefixes, they can't be ignored.

I guessed the match didn't use Regex?

[... tensorflow]$ erdtree -l 1 -p "."
. (228.41 MB)
├─ CODE_OF_CONDUCT.md (5.37 KB)
├─ .pylintrc (0 B)
├─ .bazelversion (6 B)
├─ tools (4.91 KB)
├─ arm_compiler.BUILD (1.18 KB)
├─ configure.py (53.52 KB)
├─ LICENSE (15.50 KB)
├─ configure (285 B)

The naked command issues the ANSI codes but they are not being processed. However, piping it through cat works:

Windows 10, MSys2, Windows Terminal.

hello, thank you for making this program. i think it'd be a good idea for erdtree to support binary prefix, since other programs like du uses binary prefix as default like following:

 $ du --help
...
 --si              like -h, but use powers of 1000 not 1024

As recommended in IEC 80000-13, this command will report sizes using SI units rather than binary units.

also, could you point me in the direction of source where it states SI unit is preferred over binary units?

Definition of prefixes using powers of 10—in which 1 kilobyte (symbol kB) is defined to equal 1,000 bytes—is recommended by the International Electrotechnical Commission (IEC)

i found relevent paragraph in byte, and it looks like it's for SI prefix using 1000 vs 1024, not that it's preferred to use SI unit over binary prefix.

I'm using:

• WSL2
• Windows 11 Pro version 22H2
• Debian (Debian GNU/Linux 11 (bullseye))
• Erdtree v 1.7.1
• Google Drive (Windows application) version 72.0.3.0

Running erdtree in /mnt/g/Shared drives/$DRIVE appears to hang - I've outputted to a file and run tail on the file for 10 minutes and had no output. Seeing as there does not appear to be a verbose output, is there any other documentation you'd like?

Sometimes, I only want the directory hierarchy and put them in one documentation. The size doesn't make sense here.

TreeNode is creating a new PathBuf when it could probably just be a Path which is an unsized type and therefore must always be borrowed.

As a user, I would like to be able to install the erdtree CLI application using the curl command. This would allow me to easily download and install the application without having to download the binary file manually or other installation methods.

I would like to contribute to this feature by creating the installation script.

et crashes when --prune is combined with a non existing --glob, e.g.:

$ cargo run -- --no-config --level 1 --prune --glob "main.rs" tests/data
    Finished dev [unoptimized + debuginfo] target(s) in 0.05s
     Running `target/debug/et --no-config --level 1 --prune --glob main.rs tests/data`
thread '<unnamed>' panicked at 'internal error: entered unreachable code: Try to access a freed node', ~/.cargo/registry/src/github.com-1ecc6299db9ec823/indextree-4.6.0/src/node.rs:45:13
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Any { .. }', src/render/tree/mod.rs:156:24

Reasoning: I would like to make an alias to change some default behavior (sort, prefixes (future), etc). However, supplying the same argument twice (et -s name -s size) is an error.

Current behavior: et -s name -s size will not execute, with the message (from clap) that --sort cannot be used multiple times.
Expected behavior: et -s name -s size will execute, and sort output by size.

(This is a 3 line change and I have a PR ready, just wanted approval first as stated in the readme)

https://www.youtube.com/watch?v=WxnN05vOuSM

Hi, I noticed erdtree is in the AUR and I installed it. Works very well, congrats!

As long-time user and collaborator to the Firejail project it didn't take long before creating a firejail profile for erdtree. That profile also works quite well, but then I hit a snag. Apparently the spreadsheet component of WPS Office is also called (and installed as) et.

Obviously that's not a problem for the erdtree dev(s) as such. I sure like short, easy to remember command names myself. Realizing what a name change of the binary entails, I don't want to suggest to do so. I just wanted to bring this to your attention.

À la tree --dirsfirst, an option to sort directories above normal files.

In my view, there are two ways to implement this:

• et --sort dir, a manually-implemented "sort by directory"
• et --sort ... --dirs-first, an option for all sorting methods to sort directories first

I have both implemented, don't know which (if either) to make a pr for.

Hi!

I've been using erdtree for a bit of time now and I'm quite happy with it, thanks for making this tool :)

I have one request though: would it possible (don't if it is) to add an option to also display the modification time of elements? It'd very, very useful for me.

Currently I use fd ... -x ls -lhd but it is quite slow, especially compared to erdtree.

I want to use erdtree to print a project's folder structure and use it in README's, but the ANSI escape sequences make it unreadable.

Something like --no-colors or --plain would do the trick.

I'd be happy to work on this feature if that's alright.

It would be nice to be able to do:

$ erdtree --filter <glob_pattern>
$ erdtree -f <glob_pattern>

For example,

$ erdtree -f !*.snap

Would filter all insta snapshot files, and

$ erdtree -f *.snap

Would only display the snapshot files.

It seems like the ignore crate already supports adding ignore overrides.

Would you accept a PR that implements this?

I really like this program, just a (small?) issue I found:

when I do cd / and then et, I get this panic:

[tom@tom-pc ~]$ cd /
[tom@tom-pc /]$ et
thread '<unnamed>' panicked at 'called `Option::unwrap()` on a `None` value', /home/tom/.cargo/registry/src/github.com-1ecc6299db9ec823/erdtree-1.2.0/src/fs/erdtree/node.rs:220:25
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Any { .. }', /home/tom/.cargo/registry/src/github.com-1ecc6299db9ec823/ignore-0.4.20/src/walk.rs:1302:31
^C

when given a directory that doesn't exist, erdtree seems to hang until it is terminated manually.

These are the last three lines displayed when running with strace:

getcwd("/home/arisun/Projects/andrea", 1024) = 29
readlink("/home/arisun/Projects/andrea/bogus", 0x7ffec44b6d50, 1023) = -1 ENOENT (No such file or directory)
futex(0x56497ab84a58, FUTEX_WAIT_BITSET_PRIVATE, 4294967295, NULL, FUTEX_BITSET_MATCH_ANY

I am running the latest release, 1.7.0 on Arch in case that matters

config file: ~/.erdtreerc, as follow:

--level 1
--icons
--scale 3

-s size
--dirs-first

run: et SomeDir

error occured:

error: unexpected argument '--dir' found

  note: argument '--dirs-first' exists

Once I delete the .erdtreerc file, and run the equivalent command: et -l 1 --icons --scale 3 -s size --dirs-first SomeDir, everything works fine.

brew doctor
Warning: Some installed kegs have no formulae!
This means they were either deleted or installed manually.
You should find replacements for the following formulae:
erdtree

running et with hidden files and ignore git doesn't seem to work. I looked into it but I couldn't track it down fully yet (I'm still trying to grok OverrideBuilder atm).

[bws:~/circadian_tools] avgday(+19/-0)+ ± et -H --ignore-git
circadian_tools (220.02 KB)
├─ src (6.18 KB)
│  ├─ chrono.rs (2.01 KB)
│  └─ lib.rs (4.18 KB)
├─ .git (197.54 KB)
│  ├─ FETCH_HEAD (96.00 B)
│  ├─ packed-refs (112.00 B)
│  ├─ refs (809.00 B)
│  │  ├─ remotes (399.00 B)
│  │  │  └─ origin (399.00 B)
│  │  │     ├─ tau (41.00 B)
│  │  │     ├─ main (41.00 B)

Maybe this code here is getting called before the show-hidden-glob gets added so it basically gets overwritten?

if self.ignore_git {
    builder.add("!.git/**/*")?;
}

My et doesn't shows mp4 files
Version: erdtree 1.6.0

❯ ls                                                                                      
'0001-FINAL [573011600].mp4'  '0003-FINAL [573012721].mp4'   lessons_links.txt
'0002-FINAL [573011998].mp4'  '0004-FINAL [573013069].mp4'   video_links.txt
❯ et                                                                                      
00-intro (709 B)
├─ video_links.txt (328 B)
└─ lessons_links.txt (381 B)

i still do not understand what is the point of making $HOME more clutter to maintain, even when we try to make it Clean / Neat

issue is regarding config-location

• $HOME/.erdtreerc
  make location good , i mean standards of unix as `.config/et/.etrc'

some work around or TIPS which i have been using to tackle it
in Window (coz i use it for now ) :(
in $profile put this
$env:ERDTREE_CONFIG_PATH="path/to/conf/"

in Unix
in .bashrc put
export ERDTREE_CONFIG_PATH=path

To reproduce, put --ignore-git-ignore in $HOME/.erdtreerc.

Then run et from a directory that has some gitignored files. They won't be printed.

For comparison, if the flag is supplied through command line: et --ignore-git-ignore, it works as expected.

> et --version
erdtree 1.4.1

$ et some_dir for example won't work if a configuration file exists.

Now that winget is the official package manager for Windows, it would be useful to use winget since it's already pre-installed for Windows machines.

Hello!

Thanks for continuing to improve this tool It's one of my favorites 🙂

After trying to upgrade to erdtree 1.3.0 with cargo install via crates.io, I got the following error output (placed inside a <details> block for brevity, with truncated path)

error[E0425]: cannot find value `metadata` in this scope
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:54:13
   |
54 |             metadata.file_index(),
   |             ^^^^^^^^ not found in this scope
   |
help: consider importing one of these items
   |
1  | use core::ptr::metadata;
   |
1  | use std::fs::metadata;
   |
1  | use std::ptr::metadata;
   |

error[E0425]: cannot find value `metadata` in this scope
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:55:13
   |
55 |             metadata.volume_serial_number(),
   |             ^^^^^^^^ not found in this scope
   |
help: consider importing one of these items
   |
1  | use core::ptr::metadata;
   |
1  | use std::fs::metadata;
   |
1  | use std::ptr::metadata;
   |

error[E0425]: cannot find value `metadata` in this scope
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:56:13
   |
56 |             metadata.number_of_links(),
   |             ^^^^^^^^ not found in this scope
   |
help: consider importing one of these items
   |
1  | use core::ptr::metadata;
   |
1  | use std::fs::metadata;
   |
1  | use std::ptr::metadata;
   |

error[E0425]: cannot find value `nlink` in this scope
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:58:42
   |
58 |             return Ok(Self::new(md, dev, nlink));
   |                                          ^^^^^
   |                                          |
   |                                          a field by this name exists in `Self`
   |                                          help: a local variable with a similar name exists: `nlinks`

error[E0308]: mismatched types
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:58:33
   |
58 |             return Ok(Self::new(md, dev, nlink));
   |                       --------- ^^ expected `u64`, found struct `Metadata`
   |                       |
   |                       arguments to this function are incorrect
   |
note: associated function defined here
  --> ${HOME}\.cargo\registry\src\github.com-1ecc6299db9ec823\erdtree-1.3.0\src\fs\inode.rs:18:12
   |
18 |     pub fn new(ino: u64, dev: u64, nlink: u64) -> Self {
   |            ^^^ --------

Some errors have detailed explanations: E0308, E0425.
For more information about an error, try `rustc --explain E0308`.
error: could not compile `erdtree` due to 5 previous errors
error: failed to compile `erdtree v1.3.0`, intermediate artifacts can be found at `${HOME}\AppData\Local\Temp\cargo-installK25LHL`

To replicate this, I simply use cargo install erdtree

i would really love if I can have
scoop manifest , so it would be easy to install on window

THX

Hello!

This is a really fantastic tool. I was wondering if there's any hope of possibly publishing this to crates.io?

Hi, I notice the Windows build is missing from the v1.6.0 release page.

After investigating, I found that an error occurred during the upload process of the Windows files in the Publish CI for the v1.6.0 release: https://github.com/solidiquis/erdtree/actions/runs/4466914178/jobs/7846464218#step:8:308

I think this might be the root cause of the issue.

Use case: you have a small number (dozens) of folders, each of which may contain thousands of files. They may be at different depths, e.g.

a/{1k files}
a/b/{1k files}
b/c/d/{1k files}

in which case you might want a report like

├─ a (123.45 MiB)
│  ├─ b (67.89 MiB)
├─ b (234.56 MiB)
│  ├─ c (56.78 MiB)
│  ├─ ├─ d (8.90 MiB)

For cases like this, would be real nice to have "dirs only" flags (e.g. -D / --dirs-only).

Apologies in advance if this is already doable and I have missed it.

I'm a simple man. I like pretty colors and file icons. So I installed this to replace tree and exa. I put up an alias to run et -i -I -s size -l 2. all nice and pretty.

Then I tried running the command at my root directory with and realized that wait, this is a tool that was made to calculate disk usage, not just print pretty trees! It took longer than necessary to just print 2 layers of folders.

So I tried --suppress-size. Still, it took the same amount of time.
So then I thought this was using the size data to possibly sort the files. I checked the source code and, yeah, it holds the data until it tries to sort. But it would be nice™ with

struct Context {
    // ...
    #[arg(short, long)]
    max_depth: Option<usize>,
}

impl Context {
    // ...
    fn max_depth(&self) -> usize {
        self.max_depth.unwrap_or(usize::MAX)
    }

    fn walk_depth(&self) -> usize {
        self.max_depth().max(self.level())
    }
}

and a little bit of WalkBuilder::max_depth() in TryFrom<&Context> for WalkParallel then account for max_depth < level by setting the file sizes of deeper folders to 0 and hopefully done?

Now this should let you look at the shallow sizes of directories, if ever that's a thing that you need to do.

Colorscheme for tree is arbitrary and hard-coded into the program; opt to use LS_COLORS instead.

Suggestion by u/OneTurnMore

for example: et --dirs-first will not sort directories above files, but if sort type is specified: et --dirs-first -s name it works as expected.

i was able to produce the expected behavior by adding a None enum variant to SortType and adding:

} else if ctx.dirs_first() {
	Order::from((SortType::None, true))
		.comparator()
		.map(|func| current_node.sort_children(func));
}

to this line, but there are probably "cleaner" approaches.

also, i noticed that clippy suggests a bunch of stylistic refactors all over. do you have an opinion against such stylistic approaches?

I'm getting used to erdtree and liking what I'm seeing. I usually run it as et --icons or et --icons --dirs-first, etc.

So now I'm wondering: Is there some file or variable I can set that sets the "default" options for et? That is, export ERDTREE=--icons ... or an .erdtreerc or .config/erdtree.toml or such file where I could put in my "always show icons" options?

I know I can make an alias, but, well, if there's a more "canonical" way of doing this, I'd prefer that.

Idea: a flags that enables reporting total file count for directories,

Could be especially useful with #84, so you could report files count like

├─ a (123.45 MiB, 123 files)
│  ├─ b (67.89 MiB, 67 files)
├─ b (234.56 MiB, 234 files)
│  ├─ c (56.78 MiB, 56 files)
│  ├─ ├─ d (8.90 MiB, 8 files)

This might be somewhat confusing because it's not the number of files in a given directory but rather total files in this directory and all subdirectories (but is otherwise consistent with total file size being reported recursively).

as title

This might lead to better cache locality: https://docs.rs/indextree/latest/indextree/

$ erdtree -l 1

thread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 2, kind: NotFound, message: "No such file or directory" }', src/file_tree/tree_node.rs:48:51
note: run with RUST_BACKTRACE=1 environment variable to display a backtrace

https://www.reddit.com/r/rust/comments/11q2j52/comment/jc2wevd/?utm_source=share&utm_medium=web2x&context=3

I encountered the following error when building version 1.8.1, and after checking the documentation and code, I realized that I needed the nightly version of Rust, but it was not specified in the README

There are 2 ways this could be done:

• A build script like dust does it
• A flag similar to how mdBook does it

I've tried to implement both solutions and the build script solution would require changing how imports are done since just including the context module essentially means having to include almost the entire project module hierarchy.

Hey mate,

First of all. BLAZINGLY FASTTTT

Into my request. It would be great if we could add some feature to view who owns the file and what permission it was granted. So basically showing rwx permission

I really like erdtree, here is little idea that I came across while using erdtree to search for files on my disk.

As the title says, it would be useful to enable "pruning" so the output only contains branches that aren't empty at the end.

Example:
let's say we have directory:

 folder_a
├─  folder_b
│  ├─  file_d (0.00 B)
│  ├─  file_c (0.00 B)
│  ├─  folder_ba
│  │  └─  file_x (0.00 B)
│  ├─  folder_bc
│  │  └─  file_z (0.00 B)
│  └─  folder_bb
│     └─  file_y (0.00 B)
├─  file_a (0.00 B)
├─  folder_c
│  ├─  file_ab (0.00 B)
│  ├─  file_ac (0.00 B)
│  ├─  file_ad (0.00 B)
│  ├─  file_f (0.00 B)
│  └─  file_e (0.00 B)
└─  file_b (0.00 B)

and I want to filter for files that contains "a": et -g "file_*a*" and the output is:

 folder_a
├─  folder_b
│  ├─  folder_bc
│  ├─  folder_ba
│  └─  folder_bb
├─  file_a (0.00 B)
└─  folder_c
   ├─  file_ab (0.00 B)
   ├─  file_ac (0.00 B)
   └─  file_ad (0.00 B)

but with the "pruning" enabled, it would skip the "dead-ends" and print just:

 folder_a
├─  file_a (0.00 B)
└─  folder_c
   ├─  file_ab (0.00 B)
   ├─  file_ac (0.00 B)
   └─  file_ad (0.00 B)

The idea is that when searching through bigger trees, the dead-ends are cluttering the output.