Milind Daraniya

Streamlining Code Analysis: Counting Lines of Source Code with cloc on Ubuntu

Published October 10th, 2023 15 min read

Analyzing the size of your source code is essential for project management and optimization. The cloc (Count Lines of Code) tool is a powerful command-line utility that provides insights into your codebase. In this post, we'll explore how to count lines of source code using cloc on an Ubuntu system and provide an example of its output.

Step 1: Installing cloc

First, let's install cloc on your Ubuntu system using the package manager:

sudo apt-get install cloc

Step 2: Counting Lines of Source Code

Once cloc is installed, you can use it to analyze your source code. Open a terminal and navigate to the directory containing your code. Then, run the following command:

cloc .

The . represents the current directory. You can replace it with a specific directory path if needed.

Example Output:

Let's say you have a project directory called my_project containing various source code files. When you run cloc ., you might see an output similar to the following:

      25 text files.
      25 unique files.
      10 files ignored.

github.com/AlDanial/cloc v 1.90  T=0.08 s (192.5 files/s, 14537.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JavaScript                       5            100             10            212
HTML                             3             20              2            176
CSS                              2              5              2             65
JSON                             3              0              0             14
-------------------------------------------------------------------------------
SUM:                            13            125             14            467
-------------------------------------------------------------------------------

In this example, cloc analyzes the project's codebase and categorizes the lines of code based on different languages. It provides a breakdown of the number of files, blank lines, comment lines, and actual code lines for each language detected in the directory.

Benefits of Using cloc for Code Analysis

  1. Insights into Codebase: cloc offers a comprehensive overview of your codebase, helping you understand the distribution of code across different languages.
  2. Project Planning: Line count analysis aids in project planning, estimation, and resource allocation.
  3. Optimization: Identifying areas with excessive lines of code can guide optimization efforts and code refactoring.

By utilizing cloc on your Ubuntu system, you can efficiently assess the size of your codebase, making informed decisions for your software development projects.