Carbon.txt syntax

This page specifies the current v0.2 syntax for carbon.txt files.

Viewing syntax for

Carbon.txt v0.2

Latest version	Language	Valid from	Valid to
true	TOML	2025-01-23	-

Syntax

Property	Parent	Type	Required	Description
org		[table]	true
↳ disclosures	org	[[array]]	false	Links to documents that show your organisations sustainability data disclosures.
↳ doc_type	disclosures	string	true	A slugified string representing the type of document you are linking to.
↳ url	disclosures	url	true	The URL of the document you are linking to.
↳ domain	disclosures	string	false	The domain for which the disclosure applies.
`[org] disclosures = [ { doc_type = "webpage", url = "https://mycompany.com/sustainability", domain = "mycompany.com" }, { doc_type = "annual-report", url = "https://mycompany.com/carbon-emissions-2022.pdf", domain = "mycompany.com" } ]`

Property	Parent	Type	Required	Description
upstream		[table]	true
↳ services	upstream	[[array]]	false	Information linking your organisation to upstream providers you use.
↳ domain	services	string	false	The domain of the organisation providing the upstream service.
↳ service_type	services	string	false	A slug representing the service provided by the upstream provider.
`[upstream] services = [ { domain = "cloud.google.com", service_type = "shared-hosting" }, { domain = "aws.amazon.com", service_type = "cdn" } ]`

Code sample

[org]
disclosures = [
	{ doc_type = "webpage", url = "https://mycompany.com/sustainability", domain = "mycompany.com" },
	{ doc_type = "annual-report", url = "https://mycompany.com/carbon-emissions-2022.pdf", domain = "mycompany.com" }
]
	
[upstream]	
services = [
	{ domain = "cloud.google.com", service_type = "shared-hosting" },
	{ domain = "aws.amazon.com", service_type = "cdn" }
]