README

Fast, reliable, and secure dependency management.



  
  
  


---

Yarn is a modern package manager split into various packages. Its novel architecture allows to do things currently impossible with existing solutions:

- Yarn supports plugins; adding a plugin is as simple as adding it into your repository
- Yarn supports Node by default but isn't limited to it - plugins can add support for other languages
- Yarn supports workspaces natively, and its CLI takes advantage of that
- Yarn uses a bash-like portable shell to make package scripts portable across Windows, Linux, and macOS
- Yarn is first and foremost a Node API that can be used programmatically (via @yarnpkg/core)
- Yarn is written in TypeScript and is fully type-checked

 Our supports

 Gold sponsors


  
    
      
        
      
      
        
      
    
    
      All your environment variables, in one place. Stop struggling with scattered API keys, hacking together home-brewed tools, and avoiding access controls. Keep your team and servers in sync with Doppler.
    
  
  
    
      
        
      
      
        
      
    
    
      Your app, enterprise-ready. Start selling to enterprise customers with just a few lines of code. Add Single Sign-On (and more) in minutes instead of months with WorkOS.
    
  


 But also


  
    
      
        
      
    
    
      Datadog has been sponsoring the time of our lead maintainer for more than a year now. They also upgraded our account so that we can benefit from long-term telemetry (RFC).
    
  
  
    
      
        
      
    
    
      SysGears also sponsored time from very early in the 2.x development. In particular, their strong investment is the reason why Yarn 2 supports node_modules installs even better than it used to.
    
  
  
    
      
        
      
    
    
      Netlify has been the historical provider for our website. Each time we got issues, they jumped to our help. Their live previews have been super helpful in our development process.
    
  
  
    
      
       
      
    
    
      Cloudflare has also been a historical partner. While we don't directly mirror the npm registry anymore, they still power our website to make its delivery as fast as possible.
    
  
  
    
      
       
      
    
    
      Algolia contributed a lot to our documentation over the years. They still power the search engine we use on both versions of the documentation.
    
  


 Installation

Consult the Installation Guide.

 Migration

Consult the Migration Guide.

 Documentation

The documentation can be found at yarnpkg.com.

 API

The API documentation can be found at yarnpkg.com/api.

 Current status

On top of our classic integration tests, we also run Yarn every day against the latest versions of the toolchains used by our community - just in case. Everything should be green!



- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 


 Contributing

Consult the Contributing Guide.

 Buil