https://github.com/kthompson/glob
A C# Glob library for .NET and .NET Core.
https://github.com/kthompson/glob
c-sharp directory-traversal dotnet dotnet-core glob glob-library
Last synced: about 2 months ago
JSON representation
A C# Glob library for .NET and .NET Core.
- Host: GitHub
- URL: https://github.com/kthompson/glob
- Owner: kthompson
- License: mit
- Created: 2011-12-29T06:55:11.000Z (almost 14 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-22T23:53:47.000Z (over 1 year ago)
- Last Synced: 2025-08-01T04:12:33.246Z (2 months ago)
- Topics: c-sharp, directory-traversal, dotnet, dotnet-core, glob, glob-library
- Language: C#
- Homepage: https://kthompson.github.io/glob/
- Size: 31.2 MB
- Stars: 225
- Watchers: 10
- Forks: 23
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Glob
[](https://gitter.im/kthompson/glob?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://automaters.visualstudio.com/Glob/_build?definitionId=7&branchFilter=51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51)
[](https://automaters.visualstudio.com/Glob/_build?definitionId=7&branchFilter=51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51)
[](https://automaters.visualstudio.com/Glob/_build?definitionId=7&branchFilter=51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51%2C51)
[](https://www.nuget.org/packages/Glob/)
A C# Glob library for .NET.
## What is a glob?
A glob is a pattern-matching syntax that shells use. Like when you do
`rm *.cs`, the `*.cs` is a glob.
See: http://en.wikipedia.org/wiki/Glob_(programming) for more info.
## Try it out!
You can test out Glob expressions using this library in your browser by visiting:
https://kthompson.github.io/glob/
[](https://kthompson.github.io/glob/)
## Supported Environments
* Windows
* Macintosh OS X (Darwin)
* Linux
## Features
### Common Expressions
| Pattern | Description |
|-------------|---------------------------------------------|
| taco* | matches any string beginning with taco |
| \*taco\* | matches any string containing taco |
| *taco | matches any string ending in taco |
| *.[ch] | matches any string ending in `.c` or `.h` |
| *.{gif,jpg} | match any string ending in `.gif` or `.jpg` |
### Expressions
| Pattern | Description |
|-----------|--------------------------------------------------------------------------------|
| * | matches any number of characters including none, excluding directory separator |
| ? | matches a single character |
| [abc] | matches one character in the brackets |
| [!abc] | matches any character not in the brackets |
| ** | match zero or more directories |
| {abc,123} | comma delimited set of literals, matched 'abc' or '123' |
### Other Features
* Escape patterns are supported using `\`
* Pure C# implementation
* No reliance on Regex
* Simple text string matching support
* File system matching APIs
## Getting Started
### Installing from NuGet
```bash
dotnet add package Glob
```
### Setup
To use Glob, you need to include the namespace:
```csharp
using GlobExpressions;
```
### Example
```csharp
var glob = new Glob("**/bin");
var match = glob.IsMatch(@"C:\files\bin\");
```
### Static Usage
#### Single file
```csharp
var match = Glob.IsMatch(@"C:\files\bin\", "**/bin");
```
#### Files in a directory
```csharp
string[] matchingFiles = Glob.Files(@"C:\files\bin\", "**/bin").ToArray();
```
#### Directories in a directory
```csharp
string[] matchingDirectories = Glob.Directories(@"C:\files\bin\", "**/bin").ToArray();
```
## Extension Methods
### DirectoryInfo.GlobDirectories
Enumerate through all matching directories recursively.
#### Params
* pattern: String
#### Example
```csharp
var root = new DirectoryInfo(@"C:\");
var allBinFolders = root.GlobDirectories("**/bin");
```
### DirectoryInfo.GlobFiles
Enumerate through all matching files recursively.
#### Params
* pattern: String
#### Example
```csharp
var root = new DirectoryInfo(@"C:\");
var allDllFiles = root.GlobFiles("**/*.dll");
```
### DirectoryInfo.GlobFileSystemInfos
Enumerate through all matching files and folders recursively.
#### Params
* pattern: String
#### Example
```csharp
var root = new DirectoryInfo(@"C:\");
var allInfoFilesAndFolders = root.GlobFileSystemInfos("**/*info");
```
## Upgrading from 1.x
In 2.x all Glob expressions no longer support `\` as path separators. Instead `/` should be used to separate paths in expressions.
The `/` path separator will still match on platform specific directory separators but `\` is reserved for escape sequences.
## Performance
[See benchmarks](test/Glob.Benchmarks/BenchmarkDotNet.Artifacts/results/GlobExpressions.Benchmarks.GlobBenchmarks-report-github.md)