How to Use Sourcegraph

Discover how to use Sourcegraph with this step-by-step guide. Learn key features, practical tips, and best practices to get started quickly.

Register Your Account

To begin your journey with us, navigate to our homepage and locate the 'Sign Up' button prominently displayed. When you click it, you will be directed to a registration form where you’ll need to fill in your personal information, including your name, email address, and a secure password. It's important to choose a strong password to ensure your account is well-protected from unauthorized access and breaches. After you've completed the form, click the 'Submit' button to create your account. You may receive a confirmation email with a link to verify your account, which you'll need to follow before proceeding.

Set Up Your Profile

Once you've registered and verified your account through the email, the next step is to set up your user profile. On your dashboard, you'll find an option to edit your profile. Here you can upload a profile picture, which is not just a requirement but also a great way to make your account feel more personalized. Fill in your bio with relevant information; this could include your professional background, interests in UX design, or any particular coding languages you're proficient in. Completing your profile not only enhances your experience but also allows other users to connect better with you based on shared interests.

Explore Key Features

After setting up your profile, take some time to explore the various key features available on the platform. These include Deep Search, Code Search, and Batch Changes among others. Familiarizing yourself with these tools will provide a clearer understanding of how you can utilize them effectively. Access these features from your main dashboard to see their locations and functionalities, which will help you navigate them in future tasks.

Start Using Deep Search

Deep Search is one of our standout features. It allows you to conduct searches using natural language, making it incredibly user-friendly, especially for beginners. To start using this feature, simply type your query in the search bar located at the top of your dashboard. The AI behind Deep Search processes your request and presents relevant results that can vastly improve your coding workflow. This is especially helpful when searching for specific functions or files within large codebases. Remember to play around with different queries to get the hang of it and see the potential of this tool.

Conduct Code Search

Next, you should explore the Code Search functionality offered by Sourcegraph. This tool is particularly useful for developers navigating complex codebases. When you enter a search term, the Code Search feature returns precise results, helping you locate specific lines of code quickly. This significantly reduces the time spent searching and allows for faster debugging and collaboration among team members. Try combining terms or phrases for more precise results.

Make Batch Changes

One of the advanced features you might find beneficial is the ability to make Batch Changes. This tool allows you to implement large-scale changes across multiple repositories all at once. To utilize this feature, select the repository or repositories where you need changes, specify the modifications desired, and Sourcegraph will automate the process for you. This capability is a game-changer for engineers managing substantial codebases, as it significantly streamlines workflow and enhances efficiency.

Gain Insights

The Insights feature provides high-level analytics and metrics concerning your code health. It offers valuable perspectives on code complexity and project stability, ultimately aiding in decision-making processes. Regularly visiting the Insights section can help you identify potential problems before they escalate, helping maintain code quality over time. Utilize this information to guide your engineering strategies and ensure your projects are poised for success.

Integrate APIs

For those interested in customization, our GraphQL and REST APIs allow extensive integration opportunities. You can connect Sourcegraph with various development tools already in your workflow, enhancing overall efficiency and coherence in your projects. Take a look at our documentation for detailed instructions on how to implement these APIs effectively. With customization, you can tailor Sourcegraph's capabilities to your team's specific needs and improve your coding environment.

Utilize the CLI

If you're more comfortable working in a terminal environment, consider using the Command Line Interface (CLI) for Sourcegraph. This allows you to run commands directly from your terminal, making it easier to perform tasks without the need to switch between applications. For example, you can access your code searches or initiate batch changes directly from the command line. This functionality not only speeds up your workflow but also enhances your overall productivity, making it a favorite among advanced users.

Use Cody

Don’t forget about Cody, our AI coding assistant. Cody is here to help bridge any gaps in your coding knowledge. If you encounter a programming challenge or need suggestions for improving your code, simply ask Cody for guidance. This feature can save you time and help you learn more about coding practices as you receive AI-driven recommendations tailored to your queries, making your coding experience smoother and more insightful.

Access Resources

To further support your experience, visit the Resources section where you can access a wealth of material including case studies and comprehensive documentation. These resources highlight how other engineering teams have successfully leveraged Sourcegraph to optimize their workflows. Familiarizing yourself with these studies can provide you with innovative ideas and best practices that you might implement in your projects. The documentation is also incredibly helpful for troubleshooting any issues you might encounter while getting started with our features.

Schedule a Demo

Finally, if you're still on the fence or would like to see a live demonstration of Sourcegraph's capabilities, navigate to our Pricing page to schedule a demo. Our team is dedicated to showcasing how Sourcegraph can be tailored to meet the specific needs of your team, providing a walkthrough of features that will enhance your development processes. Scheduling a demo is an excellent opportunity for you and your team to ask questions and see the platform in action.