Quick start guide
Before you start
Before you start working with AppCode, make sure that you have the supported Xcode version installed on your macOS.
AppCode uses the same project model and project file and synchronizes all changes with Xcode. You can work simultaneously in both IDEs, make changes, and jump back and forth – AppCode will make sure that everything is synchronized and up to date.
Open/create a project in AppCode
Open an existing project
From the Welcome screen, click . Alternatively, when the IDE main window is open, select or from the main menu.
Select the xcodeproj or xcworkspace file or a directory containing these files.
Check out a project from Version Control
Create a new project
From the Welcome screen, click . Alternatively, when the IDE main window is open, select from the main menu.
In the dialog that opens, select a target and a project template. AppCode supports all Xcode templates, so you can create new projects the same way you do in Xcode.
For more information on creating projects in AppCode, see Create a new project.
When a project is open, you see the main window divided into several logical areas.
The Project tool window on the left side presents your project in a familiar way, like Xcode does.
Using the selector in the top right corner, you can switch between different views.The Project view reflects the logical structure of a project, whereas the Files view provides physical representation of a project in a file system. In Files view, you can mark some directories of your project as excluded or as library files in order to exclude them from indexing.
The navigation bar lets you navigate through the project structure and open necessary files.
From the toolbar, you can quickly access frequently used commands, such as Run , Debug , Search Everywhere , Run Anything , and others.
From the run/debug configuration selector, you can pick a configuration and choose a device or simulator to run your app on.
If you use a version control system, the most popular VCS operations will be available from the toolbar.
When the toolbar is disabled, all the buttons are placed next to the navigation bar.
The left gutter shows the breakpoints and allows navigating through the code hierarchy, for example, going to definition, subclass, superclass, and so on. It also can show line numbers (right-click the gutter area and select Show Line Numbers) and per-line VCS history.
To the right of the editor, you can see the scrollbar and the right gutter that shows color stripes indicating errors and warnings in the current file.
Tool windows are specialized windows attached to the bottom and sides of your workspace. They provide access to typical tasks such as project management, source code search and navigation, running and debugging, integration with version control systems, and so on. For more information on tool windows, see Tool windows.
The status bar shows various warnings and information messages like file encoding, line separator, inspection profile, and so on. In addition, here you can find the Resolve Context selector for switching between the debug and release contexts to resolve your code in the IDE with the desired definitions.
Hide/show the interface elements
You can hide the UI elements that you don't need and show them again if necessary.
To hide/show tool windows, clickfrom the main menu and select the tool window that you want to hide or show.
To hide/show other interface elements (status bar, navigation bar, and so on), clickfrom the main menu and select or deselect the interface element from the list that opens.
Alternatively, press ⇧⌘A, type the UI element name, and use the switcher to show or hide the element:
Customize your environment
Feel free to tweak the IDE, so it suits your needs perfectly and is as helpful and comfortable as it can be. Go to to see the list of available customization options.
Go to AppCode | Preferences | Appearance and Behavior | Appearance to select the UI theme: Light, Darcula, or High contrast.
Go to AppCode | Preferences | Editor to adjust the editor’s behavior. A lot of options are available here, such as drag'n'rop enabling, scrolling configuration, color configuration for each available languages, tabs and code folding settings, code completion behavior, and postfix templates. For more information on the editor settings, see Editor basics.
Code style settings can be defined for each language under AppCode | Preferences | Editor | Code Style. These settings allow you to have your code automatically formatted as you write it, without any additional actions. You can also create and save your own coding style schemes.
AppCode uses the keyboard-centric approach, meaning that nearly all actions possible in the IDE are mapped to keyboard shortcuts.
AppCode supplies you with a default keymap. Selectfrom the main menu to see the whole list of predefined shortcuts.
However, you can always change it in. There are various predefined keymaps, such as Xcode, Emacs, Visual Studio, Eclipse, or NetBeans, and you can also create your own keymap based on an existing one.
Write code with smart assistance
The following features will help you save time and avoid errors when writing code.
There are two types of code completion in AppCode: basic ⌃Space and smart ⌃⇧Space. Basic completion works as you type and completes any name instantly. Smart completion analyzes the context you’re currently working in and offers more accurate suggestions based on that analysis. It filters the list of functions and variables to match the expression type.
With AppCode, you can easily generate code for common constructs and recurring elements, such us loops, conditions, enumerations, initializers, properties, methods' overrides, and more. When you create new files, AppCode also generates some initial content for them.
Use Generate popup menu
Press ⌘N or selectfrom the main menu to generate such constructs as initializers, methods' implementations and overrides, and so on. Depending on the context and programming language, AppCode suggests different sets of available code constructs.
To quickly add stub code for a method's implementation or override, press ⌃I or ⌃O respectively and find the method to override/implement in the list that opens.
Generate code from usage
You can also generate code from usage for properties that you want to use but have not yet defined. To do this, press ⌥⏎ and select Create property '<name>'.
Use live templates
Live templates are a tool to generate entire code constructs. Find the list of ready-to-use templates in .
To paste a template in your code, callor press ⌘J.
To quickly surround your code with loops and conditional statements like
for, click from the main menu or press ⌥⌘T.
If there is no predefined template for code constructs which you want to add, you can create your own live template.
Refactorings help improve your code without adding new functionality, making it cleaner and easier to read and maintain.
Select Refactor from the main menu or call the Refactor This popup ⌃T to get the list of refactorings available at the current location. Different sets of refactorings are available for Swift and Objective-C.
Most popular refactorings supported in AppCode
Renames an element and its usages.
Changes the call signature of a method.
|Move and copy|
Moves/copies an element.
Makes sure that you do not delete files referenced in your source code.
Extracts code fragments into methods and helps you reduce the code duplication.
Declares a new constant and initializes it with the selected expression.
Adds a new parameter to a method declaration and updates the method calls accordingly.
Declares a new variable and initializes it with the selected expression.
Inlines an element. Acts as opposite of extracting.
Keep your code neat
AppCode constantly tracks the quality of your code and detects potential errors and problems, such as unused code, unresolved methods, non-localized strings, or invalid parameters in a function. For this purpose, AppCode provides a set of code inspections. The detected issues are marked with the color stripes in the right gutter.
When you place the caret at the problem code string, the light bulbs appear: yellow for warnings and red for errors. Click the bulb icon or press ⌥⏎ to call the list of suggested quick-fixes.
You can also run inspections manually to find potential problems in your project and fix them at once. To do so, choose from the main menu.
You can see the whole list of inspection, change their severity level, and enable/disable them in.
Apart from the quick-fixes provided by code inspections, AppCode suggests intention actions for code fragments that can be altered and optimized. For example, you can remove explicit types from variable declarations in Swift:
You can see the whole list of intention actions and enable/disable them in.
Explore your code
When your project is big, or when you have to work with someone else’s code, it’s vital to be able to quickly find what you are looking for and dig into the code. This is why AppCode comes with a set of navigation and search features that help you find your way through any code no matter how tangled it is.
To find all usages of the symbol at the caret, run the Find Usages search by pressing ⌥F7.
To search for anything in AppCode, be it an item in your codebase, action, or UI element, press ⇧ twice and start typing what you are looking for.
Use the Find Action search ⇧⌘A to find any IDE command or setting by its name. When searching for a setting, type / to see the list of all settings that you can quickly access.
Source code navigation
File by its name
Class by its name
Symbol by its name
|Declaration of a symbol|
⌘B or the icon in the left gutter (for Objective-C)
|Implementation of a class/method|
⌥⌘B or the / icons in the left gutter
You can also navigate through the structure of the currently opened file from the Structure popup ⌘F12 or Structure tool window ⌘7.
Quick definition and documentation
Quick definition ⌥Space helps you see the contents of a class or method without jumping to it.
To see the list of parameters that a method can take, press ⌘P.
To view documentation for a symbol at the caret, press F1. Note that the symbol must be supplied with documentation comments created in accordance with AppleDoc/HeaderDoc/Doxygen markup, or with documentation from an SDK.
Also, AppCode shows external documentation for Foundation Framework Classes. To open external documentation, press ⇧F1.
Run, debug, and test your app
To run an app, select a run/debug configuration and a device or simulator from the run/debug configuration selector in the toolbar and click or press ⌃R.
Run/debug configuration is a named run/debug setup that includes target, executable, arguments to pass to the app, and other options.
Run configurations in AppCode are equivalents of Xcode schemes, and they are kept synced with Xcode schemes.
AppCode creates a default run/debug configuration for each target and names it after your project. You can also add your own configurations based on available templates. Select from the main menu to see all available configurations, edit them, and add new ones.
Debugging starts with placing breakpoints at which program execution will be suspended, so you can explore the program data. Click the left gutter of the line where you want the breakpoint to appear.
To start a debugging session, click or press ⌃D. The Debug tool window opens.
Go through the program execution using the stepping actions: step over , step into , step out , and others.
You can set variable values, evaluate expressions, add watches, step into disassembled code, attach to local and remote processes, and more. Refer to the Debugging section to learn more about debugging features in AppCode.
To create a test, right-click a node in the Project tool window, select , and AppCode will generate a standard XCTest test from a template. You can also create your own template for a test or for any other file under .
Create a run/debug configuration for your test, choose it from the run/debug configuration selector, and click or press ⌃R.
You can run several tests at once. To do so, create a compound run/debug configuration that includes your test configurations.
Test results are displayed in the dedicated view of the Run tool window. Here you can navigate to problems, see the test running statistics, and re-run failing tests.
Run your unit tests with coverage to see how much of your code is being executed during the tests.
Keep your source code under version control
AppCode integrates with the following version control systems: Git (or GitHub), Mercurial, Perforce, and Subversion.
To specify credentials and any settings specific to a particular VCS, go to VCS menu, you can commit and push changes, update projects, and more. From the Version Control tool window ⌘9, it's possible to manage change lists.. From the
Some basic commands can be easily accessed from the toolbar.
In addition to traditional version control, you can use Local History. With Local History, AppCode automatically tracks changes you make to the source code, the results of refactoring, and so on. Local History is always enabled. To view it for a file or a folder, select . Here you can review the changes, revert them, or create a patch.
That’s it! Develop with pleasure!
We hope this brief overview of essential AppCode features will give you a quick start. There are many important features that make a developer’s life easier and more fun, and their source code neater and cleaner. Take these first few steps now, and then dig deeper when you feel the time is right. Enjoy AppCode!
With any questions visit our AppCode Discussion Forum, twitter and blog, where you can find news, updates, and useful tips and tricks. Also, don't hesitate to report any problems to our support team or the AppCode issue tracker.