index.md

title	layout
OmniSharp - .NET and IntelliSense on any platform with your editor of choice	default

Welcome to OmniSharp...for your editor!

OmniSharp is a family of Open Source projects, each with one goal - To enable great .NET development in YOUR editor of choice.

It's fun to say Cross Platform .NET. But is it reasonable for someone to develop .NET without Visual Studio and Windows?

Is it fun to do .NET on a Mac in Sublime? Ubuntu and Emacs? Windows and Atom? You can use your editor PLUS get to use great features like Intellisense (not just Autocomplete), Add Reference, Format Document, and lots more. Develop anywhere, deploy anywhere (and to Azure!)

Yes. Here's how to get started

Get ASP.NET 5 for your platform.

Sublime Text 3

• Install the Kulture plugin from Package Control.
• Install the OmniSharp plugin from Package Control and read the docs here.
• Optionally change your C# language settings to launch Intellisense on . and <.
• Optionally install a C# Snippets package.

Atom

• Install the Autocomplete Plus package.
• Install the Omnisharp Atom package.

And more info in the OmniSharp Atom wiki!

Emacs

• Short version
  • Enable the MELPA stable package archive. Use MELPA stable for official releases, or plain MELPA for development snapshots.
  • M-x package-install RET omnisharp RET
  • Clone omnisharp-server to a location of your choosing
  • Build it :)
  • Download curl
  • Customize omnisharp with M-x customize-group RET omnisharp RET
  • Currently there are default keybinding suggestions for evil-mode users at github. Adopt them or create your own!
  • Start omnisharp with M-x omnisharp-mode RET or automatically in a mode hook
• Long version
  • See here

Brackets

• Install the Omnisharp extension from the extension manager within Brackets.io

Vim

• Short version
  • Install OmniSharp, vim-dispatch, CtrlP & Syntastic using your favourite method.
  • Build the OmniSharp server
  • Install Python 2.7.5
  • Create some keybindings
• Long version
  • See here

Command line only

• Create projects using yeoman aspnet generators
• Download NuGet, npm and Bower resources with dnu restore
• Build projects using dnu build
• Run project from the command line with dnx . web or dnx . run
• Package projects for publishing with dnu pack

Yeoman generators

Getting started with projects is easy using yeoman. Here are some generators that you can use to get started.

generator-aspnet

The goal of generator-aspnet is to provide an experience consistent with creating new ASP.NET 5 (DNX) projects and files in Visual Studio 2015. Below are some other related generators that you may be interested in.

If you are working on a related generator please open an issue to let us know about it so that we can add it to the list.

Authors and Contributors

Jason Imison (@nosami), Jonathan Channon (@jchannon), Martijn Laarman (@Mpdreamz), Mat McLoughlin (@mat-mcloughlin), Stephen James (@stephen-james), Sayed Ibrahim Hashimi (@sayedihashimi) Scott Hanselman (@shanselman), Mika Vilpas @sp3ctum, and Shayne Boyer (@spboyer).

Contact us

Come hang out with us on Slack!