Skip to content

module FileUtils

Extended modules

FileUtils

Methods

#cd(path : String)

Changes the current working directory of the process to the given string path.

require "file_utils"

FileUtils.cd("/tmp")

Note

Alias of Dir.cd

View source

#cd(path : String

Changes the current working directory of the process to the given string path and invoked the block, restoring the original working directory when the block exits.

require "file_utils"

FileUtils.cd("/tmp") { Dir.current } # => "/tmp"

Note

Alias of Dir.cd with block

View source

#cmp(filename1 : String, filename2 : String)

Compares two files filename1 to filename2 to determine if they are identical. Returns true if content are the same, false otherwise.

require "file_utils"

File.write("file.cr", "1")
File.write("bar.cr", "1")
FileUtils.cmp("file.cr", "bar.cr") # => true

Note

Alias of File.same_content?

View source

#cp(src_path : String, dest : String)

Copies the file src_path to the file or directory dest. If dest is a directory, a file with the same basename as src_path is created in dest Permission bits are copied too.

require "file_utils"

File.touch("afile")
File.chmod("afile", 0o600)
FileUtils.cp("afile", "afile_copy")
File.info("afile_copy").permissions.value # => 0o600
View source

#cp(srcs : Enumerable(String), dest : String)

Copies a list of files src to dest. dest must be an existing directory.

require "file_utils"

Dir.mkdir("files")
FileUtils.cp({"bar.cr", "afile"}, "files")
View source

#cp_r(src_path : String, dest_path : String)

Copies a file or directory src_path to dest_path. If src_path is a directory, this method copies all its contents recursively. If dest is a directory, copies src to dest/src.

require "file_utils"

FileUtils.cp_r("files", "dir")
View source

#ln(src_path : String, dest_path : String)

Creates a hard link dest_path which points to src_path. If dest_path already exists and is a directory, creates a link dest_path/src_path.

require "file_utils"

# Create a hard link, pointing from /usr/bin/emacs to /usr/bin/vim
FileUtils.ln("/usr/bin/vim", "/usr/bin/emacs")
# Create a hard link, pointing from /tmp/foo.c to foo.c
FileUtils.ln("foo.c", "/tmp")
View source

#ln(src_paths : Enumerable(String), dest_dir : String)

Creates a hard link to each path in src_paths inside the dest_dir directory. If dest_dir is not a directory, raises an ArgumentError.

require "file_utils"

# Create /usr/bin/vim, /usr/bin/emacs, and /usr/bin/nano as hard links
FileUtils.ln(["vim", "emacs", "nano"], "/usr/bin")
View source

#ln_s(src_path : String, dest_path : String)

Creates a symbolic link dest_path which points to src_path. If dest_path already exists and is a directory, creates a link dest_path/src_path.

require "file_utils"

# Create a symbolic link pointing from logs to /var/log
FileUtils.ln_s("/var/log", "logs")
# Create a symbolic link pointing from /tmp/src to src
FileUtils.ln_s("src", "/tmp")
View source

#ln_s(src_paths : Enumerable(String), dest_dir : String)

Creates a symbolic link to each path in src_paths inside the dest_dir directory. If dest_dir is not a directory, raises an ArgumentError.

require "file_utils"

# Create symbolic links in src/ pointing to every .c file in the current directory
FileUtils.ln_s(Dir["*.c"], "src")
View source

#ln_sf(src_path : String, dest_path : String)

Like #ln_s(String, String), but overwrites dest_path if it exists and is not a directory or if dest_path/src_path exists.

require "file_utils"

# Create a symbolic link pointing from bar.c to foo.c, even if bar.c already exists
FileUtils.ln_sf("foo.c", "bar.c")
View source

#ln_sf(src_paths : Enumerable(String), dest_dir : String)

Creates a symbolic link to each path in src_paths inside the dest_dir directory, ignoring any overwritten paths.

If dest_dir is not a directory, raises an ArgumentError.

require "file_utils"

# Create symbolic links in src/ pointing to every .c file in the current directory,
# even if it means overwriting files in src/
FileUtils.ln_sf(Dir["*.c"], "src")
View source

#mkdir(paths : Enumerable(String), mode = 511) : Nil

Creates a new directory at the given paths. The linux-style permission mode can be specified, with a default of 777 (0o777).

require "file_utils"

FileUtils.mkdir(["foo", "bar"])
View source

#mkdir(path : String, mode = 511) : Nil

Creates a new directory at the given path. The linux-style permission mode can be specified, with a default of 777 (0o777).

require "file_utils"

FileUtils.mkdir("src")

Note

Alias of Dir.mkdir

View source

#mkdir_p(path : String, mode = 511) : Nil

Creates a new directory at the given path, including any non-existing intermediate directories. The linux-style permission mode can be specified, with a default of 777 (0o777).

require "file_utils"

FileUtils.mkdir_p("foo")

Note

Alias of Dir.mkdir_p

View source

#mkdir_p(paths : Enumerable(String), mode = 511) : Nil

Creates a new directory at the given paths, including any non-existing intermediate directories. The linux-style permission mode can be specified, with a default of 777 (0o777).

require "file_utils"

FileUtils.mkdir_p(["foo", "bar", "baz", "dir1", "dir2", "dir3"])
View source

#mv(src_path : String, dest_path : String) : Nil

Moves src_path to dest_path.

require "file_utils"

FileUtils.mv("afile", "afile.cr")

Note

Alias of File.rename

View source

#mv(srcs : Enumerable(String), dest : String) : Nil

Moves every srcs to dest.

require "file_utils"

FileUtils.mv(["foo", "bar"], "src")
View source

#pwd : String

Returns the current working directory.

require "file_utils"

FileUtils.pwd

Note

Alias of Dir.current

View source

#rm(path : String) : Nil

Deletes the path file given.

require "file_utils"

FileUtils.rm("afile.cr")

Note

Alias of File.delete

View source

#rm(paths : Enumerable(String)) : Nil

Deletes all paths file given.

require "file_utils"

FileUtils.rm(["dir/afile", "afile_copy"])
View source

#rm_r(path : String) : Nil

Deletes a file or directory path. If path is a directory, this method removes all its contents recursively.

require "file_utils"

FileUtils.rm_r("dir")
FileUtils.rm_r("file.cr")
View source

#rm_r(paths : Enumerable(String)) : Nil

Deletes a list of files or directories paths. If one path is a directory, this method removes all its contents recursively.

require "file_utils"

FileUtils.rm_r(["files", "bar.cr"])
View source

#rm_rf(path : String) : Nil

Deletes a file or directory path. If path is a directory, this method removes all its contents recursively. Ignores all errors.

require "file_utils"

FileUtils.rm_rf("dir")
FileUtils.rm_rf("file.cr")
FileUtils.rm_rf("non_existent_file")
View source

#rm_rf(paths : Enumerable(String)) : Nil

Deletes a list of files or directories paths. If one path is a directory, this method removes all its contents recursively. Ignores all errors.

require "file_utils"

FileUtils.rm_rf(["dir", "file.cr", "non_existent_file"])
View source

#rmdir(path : String) : Nil

Removes the directory at the given path.

require "file_utils"

FileUtils.rmdir("baz")

Note

Alias of Dir.rmdir

View source

#rmdir(paths : Enumerable(String)) : Nil

Removes all directories at the given paths.

require "file_utils"

FileUtils.rmdir(["dir1", "dir2", "dir3"])
View source

#touch(paths : Enumerable(String), time : Time = Time.utc)

Attempts to set the access and modification times of each file given in the paths parameter to the value given in time.

If the file does not exist, it will be created.

require "file_utils"

FileUtils.touch(["foo", "bar"])
View source

#touch(path : String, time : Time = Time.utc)

Attempts to set the access and modification times of the file named in the path parameter to the value given in time.

If the file does not exist, it will be created.

require "file_utils"

FileUtils.touch("afile.cr")

Note

Alias of File.touch

View source