2019-10-21 04:22:28 -04:00
---
title: os.Stat
2021-12-08 02:42:31 -05:00
description: Returns a FileInfo structure describing a file or directory.
2019-10-21 04:22:28 -04:00
date: 2018-08-07
publishdate: 2018-08-07
2021-12-08 02:42:31 -05:00
lastmod: 2021-11-26
2019-10-21 04:22:28 -04:00
categories: [functions]
menu:
docs:
parent: "functions"
keywords: [files]
signature: ["os.Stat PATH"]
workson: []
hugoversion:
2021-12-08 02:42:31 -05:00
relatedfuncs: ['os.FileExists','os.ReadDir','os.ReadFile']
2019-10-21 04:22:28 -04:00
deprecated: false
aliases: []
---
2021-12-08 02:42:31 -05:00
The `os.Stat` function attempts to resolve the path relative to the root of your project directory. If a matching file or directory is not found, it will attempt to resolve the path relative to the [`contentDir` ]({{< relref "getting-started/configuration#contentdir">}} ). A leading path separator (`/`) is optional.
2019-10-21 04:22:28 -04:00
2021-12-08 02:42:31 -05:00
```go-html-template
{{ $f := os.Stat "README.md" }}
{{ $f.IsDir }} --> false (bool)
{{ $f.ModTime }} --> 2021-11-25 10:06:49.315429236 -0800 PST (time.Time)
{{ $f.Name }} --> README.md (string)
{{ $f.Size }} --> 241 (int64)
2019-10-21 04:22:28 -04:00
2021-12-08 02:42:31 -05:00
{{ $d := os.Stat "content" }}
{{ $d.IsDir }} --> true (bool)
```
2019-10-21 04:22:28 -04:00
2021-12-08 02:42:31 -05:00
Details of the `FileInfo` structure are available in the [Go documentation ](https://pkg.go.dev/io/fs#FileInfo ).