---
title: "oneyaml Go docs"
url: https://recursiveai.org/oneyaml/go/docs/
description: "Everything about oneyaml for Go: getting started, editing, patches, limits, moving from yaml.v3 and sigs.k8s.io/yaml, how it compares, and the reference."
version: "1.0.0"
---

# oneyaml Go docs

Everything about oneyaml for Go: getting started, editing, patches, limits, moving from yaml.v3 and sigs.k8s.io/yaml, how it compares, and the reference.

## Start

- [Getting started](https://recursiveai.org/oneyaml/go/docs/getting-started/index.md): Install the module, read YAML into Go structs, write it back, edit a document in place and keep its comments, and apply JSON Patch and merge patches.
- [Overview](https://recursiveai.org/oneyaml/go/docs/overview/index.md): The module README: what oneyaml-go is, the quick start, when to use it and when not, correctness, the yaml.v3 and sigs.k8s.io/yaml adapters, and stability.

## Guides

- [Editing](https://recursiveai.org/oneyaml/go/docs/editing/index.md): How Document changes a YAML file and what it promises to leave alone. For the API reference see pkg.go.dev; for patches see Patches.
- [Patches](https://recursiveai.org/oneyaml/go/docs/patches/index.md): How to apply a patch to a YAML file. The operations are those of JSON Patch (RFC 6902), the paths are JSON Pointers (RFC 6901), and merge patches follow…
- [Limits](https://recursiveai.org/oneyaml/go/docs/limits/index.md): Limits stop input from using more time or memory than you intended. By default, nesting depth, alias expansion, the digits of a number and the work of a…

## Migrating

- [From yaml.v3](https://recursiveai.org/oneyaml/go/docs/migrate-yaml-v3/index.md): Two ways to move from gopkg.in/yaml.v3 (or go.yaml.in/yaml/v3): keep your code and swap the import to the compat/yamlv3 adapter, or move to the oneyaml…
- [From sigs.k8s.io/yaml](https://recursiveai.org/oneyaml/go/docs/migrate-sigs-k8s-yaml/index.md): Two ways to move from sigs.k8s.io/yaml (and its parent ghodss/yaml): keep your code and swap the import to the compat/k8syaml adapter, or move to the…

## Choosing

- [Comparison](https://recursiveai.org/oneyaml/go/docs/comparison/index.md): How oneyaml-go compares with the Go YAML libraries it is most often weighed against: gopkg.in/yaml.v3 (and its maintained fork go.yaml.in/yaml/v3), its…
- [Performance](https://recursiveai.org/oneyaml/go/docs/performance/index.md): This page compares the time and memory of oneyaml-go with those of the other Go YAML libraries. Every library runs the same tasks on the same inputs…

## Reference

- [Conformance](https://recursiveai.org/oneyaml/go/docs/conformance/index.md): What oneyaml-go is measured against, the latest results, and every case it is known not to pass.
- [Changelog](https://recursiveai.org/oneyaml/go/docs/changelog/index.md): All notable changes are listed here, newest first. The format follows Keep a Changelog, and versions follow Semantic Versioning. Breaking changes are…

## Cookbook

- [All recipes](https://recursiveai.org/oneyaml/go/cookbook/index.md): 10 short, task-first recipes with complete code.