Checkpointing documentation by louisjimenez · Pull Request #1321 · google-gemini/gemini-cli

louisjimenez · 2025-06-23T04:14:51Z

This documentation covers how the checkpointing feature works and how to use it.

github-actions · 2025-06-23T12:06:15Z

Code Coverage Summary

Package	Lines	Statements	Functions	Branches
CLI	68.07%	68.07%	71.88%	75.04%
Core	69.89%	69.89%	74.82%	80.87%

CLI Package - Full Text Report

-------------------|---------|----------|---------|---------|-------------------
File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
-------------------|---------|----------|---------|---------|-------------------
All files          |   68.07 |    75.04 |   71.88 |   68.07 |                   
 src               |   42.04 |    53.12 |    37.5 |   42.04 |                   
  gemini.tsx       |   16.74 |    14.28 |   16.66 |   16.74 | ...67-216,221-292 
  ...ractiveCli.ts |   91.96 |       64 |     100 |   91.96 | ...14,117,140-141 
 src/config        |   80.06 |    67.56 |   81.48 |   80.06 |                   
  auth.ts          |    12.5 |      100 |       0 |    12.5 | 11-46             
  config.ts        |   91.48 |    68.42 |   66.66 |   91.48 | ...89-290,300-301 
  extension.ts     |    73.8 |    70.58 |     100 |    73.8 | ...01-105,114-115 
  sandboxConfig.ts |   51.35 |    16.66 |   66.66 |   51.35 | ...43,53-69,74-91 
  settings.ts      |   92.44 |    79.54 |     100 |   92.44 | ...25-226,262-263 
 src/generated     |     100 |      100 |     100 |     100 |                   
  git-commit.ts    |     100 |      100 |     100 |     100 |                   
 src/ui            |   60.19 |    53.52 |   73.68 |   60.19 |                   
  App.tsx          |   57.68 |    42.85 |      80 |   57.68 | ...41-752,758-787 
  colors.ts        |   86.04 |      100 |   76.92 |   86.04 | 12-13,18-19,42-43 
  constants.ts     |       0 |        0 |       0 |       0 | 1-15              
  types.ts         |     100 |      100 |     100 |     100 |                   
 src/ui/components |   60.34 |    56.99 |   57.14 |   60.34 |                   
  AboutBox.tsx     |     100 |      100 |     100 |     100 |                   
  AsciiArt.ts      |     100 |      100 |     100 |     100 |                   
  AuthDialog.tsx   |   86.95 |    88.88 |      50 |   86.95 | 66-77             
  ...nProgress.tsx |   15.78 |      100 |       0 |   15.78 | 17-57             
  ...Indicator.tsx |   15.15 |      100 |       0 |   15.15 | 17-47             
  ...lePatcher.tsx |   73.17 |      100 |   66.66 |   73.17 | 34-46             
  ...ryDisplay.tsx |   21.05 |      100 |       0 |   21.05 | 17-35             
  ...ryDisplay.tsx |   97.82 |    95.83 |     100 |   97.82 | 59                
  ...esDisplay.tsx |   10.52 |      100 |       0 |   10.52 | 24-82             
  ...ngsDialog.tsx |    6.76 |      100 |       0 |    6.76 | 26-168            
  Footer.tsx       |   71.42 |    11.11 |     100 |   71.42 | ...,92-99,102-105 
  ...ngSpinner.tsx |      80 |    33.33 |     100 |      80 | 29,31-32          
  Header.tsx       |   96.87 |       60 |     100 |   96.87 | 27                
  Help.tsx         |    4.81 |      100 |       0 |    4.81 | 17-128            
  ...emDisplay.tsx |   68.65 |       50 |     100 |   68.65 | ...53-58,81-88,91 
  InputPrompt.tsx  |   57.22 |    39.74 |     100 |   57.22 | ...11-415,426-435 
  ...Indicator.tsx |     100 |      100 |     100 |     100 |                   
  ...geDisplay.tsx |   25.92 |      100 |       0 |   25.92 | 14-36             
  ...ryDisplay.tsx |      94 |       50 |     100 |      94 | 50-52             
  ...Indicator.tsx |   44.44 |      100 |       0 |   44.44 | 12-17             
  ...MoreLines.tsx |      60 |       25 |     100 |      60 | 24-27,33-40       
  Stats.tsx        |     100 |      100 |     100 |     100 |                   
  StatsDisplay.tsx |     100 |      100 |     100 |     100 |                   
  ...nsDisplay.tsx |    8.47 |      100 |       0 |    8.47 | 26-93             
  ThemeDialog.tsx  |    82.7 |       20 |      25 |    82.7 | ...,95-99,197-208 
  Tips.tsx         |     100 |      100 |     100 |     100 |                   
  ...ification.tsx |   36.36 |      100 |       0 |   36.36 | 15-22             
 ...nents/messages |   62.38 |    81.48 |   57.89 |   62.38 |                   
  ...onMessage.tsx |   18.51 |      100 |       0 |   18.51 | 22-49             
  DiffRenderer.tsx |   96.31 |    82.66 |     100 |   96.31 | ...01-202,206,271 
  ErrorMessage.tsx |   22.22 |      100 |       0 |   22.22 | 16-31             
  ...niMessage.tsx |   18.51 |      100 |       0 |   18.51 | 20-43             
  ...geContent.tsx |   19.04 |      100 |       0 |   19.04 | 25-43             
  InfoMessage.tsx  |     100 |      100 |     100 |     100 |                   
  ...onMessage.tsx |   38.91 |     62.5 |   33.33 |   38.91 | ...32-164,200-225 
  ...upMessage.tsx |     9.3 |      100 |       0 |     9.3 | 26-123            
  ToolMessage.tsx  |   89.39 |     82.6 |     100 |   89.39 | ...,82-86,160-162 
  UserMessage.tsx  |     100 |      100 |     100 |     100 |                   
  ...llMessage.tsx |   36.36 |      100 |       0 |   36.36 | 17-25             
 ...ponents/shared |      74 |    72.75 |    82.6 |      74 |                   
  MaxSizedBox.tsx  |   78.24 |     79.2 |   88.88 |   78.24 | ...19-421,520-521 
  ...tonSelect.tsx |   88.05 |    92.85 |      60 |   88.05 | ...,68-71,108-109 
  text-buffer.ts   |   71.84 |    68.69 |   88.88 |   71.84 | ...1393,1396-1397 
 src/ui/contexts   |   95.58 |    66.66 |     100 |   95.58 |                   
  ...owContext.tsx |   91.07 |    81.81 |     100 |   91.07 | 46-47,59-61       
  ...onContext.tsx |     100 |    58.82 |     100 |     100 | 65-71             
  ...ngContext.tsx |   71.42 |       50 |     100 |   71.42 | 17-20             
 src/ui/editors    |   93.33 |    85.71 |   66.66 |   93.33 |                   
  ...ngsManager.ts |   93.33 |    85.71 |   66.66 |   93.33 | 49,63-64          
 src/ui/hooks      |   71.37 |    82.41 |   69.23 |   71.37 |                   
  ...dProcessor.ts |   81.87 |    82.75 |     100 |   81.87 | ...94-397,408-424 
  ...dProcessor.ts |      82 |    74.35 |      80 |      82 | ...15-324,328-329 
  ...dProcessor.ts |   65.53 |     80.5 |   52.38 |   65.53 | ...1016,1030-1031 
  ...uthCommand.ts |    5.71 |      100 |       0 |    5.71 | 16-19,22-93       
  ...tIndicator.ts |     100 |      100 |     100 |     100 |                   
  useCompletion.ts |   50.99 |    81.13 |      60 |   50.99 | ...41-346,411-414 
  ...leMessages.ts |   96.92 |    88.88 |     100 |   96.92 | 25-26             
  ...orSettings.ts |     100 |      100 |     100 |     100 |                   
  ...miniStream.ts |   67.86 |    76.51 |     100 |   67.86 | ...65,667,718-808 
  ...BranchName.ts |   91.66 |    84.61 |     100 |   91.66 | 57-63             
  ...oryManager.ts |   98.41 |    93.33 |     100 |   98.41 | 43                
  ...putHistory.ts |    92.5 |    85.71 |     100 |    92.5 | 62-63,71,93-95    
  ...gIndicator.ts |     100 |      100 |     100 |     100 |                   
  useLogger.ts     |      25 |      100 |       0 |      25 | 14-32             
  ...raseCycler.ts |   95.48 |       75 |     100 |   95.48 | ...65-166,184-186 
  ...lScheduler.ts |   79.01 |    94.87 |     100 |   79.01 | ...00-203,293-303 
  ...oryCommand.ts |       0 |        0 |       0 |       0 | 1-7               
  ...ellHistory.ts |   91.95 |    79.16 |   83.33 |   91.95 | 28-30,41-42,87-88 
  ...oryCommand.ts |    4.91 |      100 |       0 |    4.91 | 12-75             
  ...tateAndRef.ts |   95.45 |    66.66 |     100 |   95.45 | 25                
  ...rminalSize.ts |   77.27 |      100 |      50 |   77.27 | 19-23             
  ...emeCommand.ts |   64.28 |     87.5 |     100 |   64.28 | ...,92-93,100-106 
  useTimer.ts      |   88.09 |    85.71 |     100 |   88.09 | 44-45,51-53       
 src/ui/themes     |   99.34 |    89.74 |     100 |   99.34 |                   
  ansi-light.ts    |     100 |      100 |     100 |     100 |                   
  ansi.ts          |     100 |      100 |     100 |     100 |                   
  atom-one-dark.ts |     100 |      100 |     100 |     100 |                   
  ayu-light.ts     |     100 |      100 |     100 |     100 |                   
  ayu.ts           |     100 |      100 |     100 |     100 |                   
  default-light.ts |     100 |      100 |     100 |     100 |                   
  default.ts       |     100 |      100 |     100 |     100 |                   
  dracula.ts       |     100 |      100 |     100 |     100 |                   
  github-dark.ts   |     100 |      100 |     100 |     100 |                   
  github-light.ts  |     100 |      100 |     100 |     100 |                   
  googlecode.ts    |     100 |      100 |     100 |     100 |                   
  no-color.ts      |     100 |      100 |     100 |     100 |                   
  theme-manager.ts |   89.53 |    84.21 |     100 |   89.53 | 64,96-101,106-107 
  theme.ts         |   98.44 |       95 |     100 |   98.44 | 304-307           
  xcode.ts         |     100 |      100 |     100 |     100 |                   
 src/ui/utils      |   43.97 |    91.34 |   83.33 |   43.97 |                   
  ...Colorizer.tsx |    80.5 |    86.95 |     100 |    80.5 | 88-89,159-183     
  ...wnDisplay.tsx |    6.31 |      100 |       0 |    6.31 | ...48-406,418-442 
  commandUtils.ts  |     100 |      100 |     100 |     100 |                   
  errorParsing.ts  |     100 |       96 |     100 |     100 | 48                
  formatters.ts    |   90.47 |    95.83 |     100 |   90.47 | 57-60             
  ...nUtilities.ts |   69.84 |    85.71 |     100 |   69.84 | 75-91,100-101     
  textUtils.ts     |   93.93 |    92.85 |     100 |   93.93 | 14-15             
  updateCheck.ts   |   28.57 |       50 |     100 |   28.57 | 15-39             
 src/utils         |    5.29 |       60 |      50 |    5.29 |                   
  cleanup.ts       |   91.66 |       50 |     100 |   91.66 | 18                
  package.ts       |   88.88 |       80 |     100 |   88.88 | 33-34             
  readStdin.ts     |    3.44 |      100 |       0 |    3.44 | 7-39              
  sandbox.ts       |       0 |        0 |       0 |       0 | 1-871             
  ...upWarnings.ts |   23.07 |      100 |       0 |   23.07 | 14-40             
  version.ts       |     100 |       50 |     100 |     100 | 11                
-------------------|---------|----------|---------|---------|-------------------

Core Package - Full Text Report

-------------------|---------|----------|---------|---------|-------------------
File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
-------------------|---------|----------|---------|---------|-------------------
All files          |   69.89 |    80.87 |   74.82 |   69.89 |                   
 src               |     100 |      100 |     100 |     100 |                   
  index.ts         |     100 |      100 |     100 |     100 |                   
 src/__mocks__/fs  |     100 |      100 |     100 |     100 |                   
  promises.ts      |     100 |      100 |     100 |     100 |                   
 src/code_assist   |   64.52 |    78.94 |   73.33 |   64.52 |                   
  codeAssist.ts    |   26.31 |      100 |       0 |   26.31 | 12-26             
  converter.ts     |    88.8 |    96.15 |   81.81 |    88.8 | 171-175,194-204   
  oauth2.ts        |   80.13 |       60 |   85.71 |   80.13 | ...67-178,196-202 
  server.ts        |   54.47 |       80 |   77.77 |   54.47 | 111-127,130-171   
  setup.ts         |    5.55 |      100 |       0 |    5.55 | 16-57             
  types.ts         |       0 |        0 |       0 |       0 | 1-160             
 src/config        |    65.7 |     82.6 |   44.68 |    65.7 |                   
  config.ts        |   65.25 |     82.6 |   44.68 |   65.25 | ...98-403,407-447 
  models.ts        |     100 |      100 |     100 |     100 |                   
 src/core          |   66.83 |    76.08 |   84.14 |   66.83 |                   
  client.ts        |   58.45 |    64.58 |   94.73 |   58.45 | ...66-382,430-490 
  ...tGenerator.ts |   41.17 |    66.66 |      50 |   41.17 | ...06,126,137-140 
  ...lScheduler.ts |   57.32 |    66.07 |   78.57 |   57.32 | ...31-561,580-638 
  geminiChat.ts    |   70.18 |    77.92 |      75 |   70.18 | ...06,521,525-533 
  geminiRequest.ts |     100 |      100 |     100 |     100 |                   
  logger.ts        |   84.61 |    82.66 |     100 |   84.61 | ...58-259,276-280 
  modelCheck.ts    |    4.65 |      100 |       0 |    4.65 | 20-68             
  ...olExecutor.ts |     100 |    66.66 |     100 |     100 | 63,93             
  prompts.ts       |   83.51 |    68.18 |     100 |   83.51 | 28-36,38,260-265  
  tokenLimits.ts   |      15 |      100 |       0 |      15 | 15-31             
  turn.ts          |   83.21 |    83.87 |     100 |   83.21 | ...33-236,249-250 
 src/services      |   83.66 |    86.11 |      75 |   83.66 |                   
  ...eryService.ts |   91.93 |       75 |     100 |   91.93 | 31,39,61-62,84    
  gitService.ts    |   78.02 |      100 |      60 |   78.02 | ...10-114,117-121 
 src/telemetry     |   78.33 |    84.53 |   81.81 |   78.33 |                   
  constants.ts     |     100 |      100 |     100 |     100 |                   
  index.ts         |     100 |      100 |     100 |     100 |                   
  loggers.ts       |   84.34 |       85 |    87.5 |   84.34 | 153-186           
  metrics.ts       |   60.36 |    95.65 |    62.5 |   60.36 | ...36-158,161-184 
  sdk.ts           |   82.85 |    28.57 |     100 |   82.85 | ...18,126-127,133 
  types.ts         |   82.32 |    97.43 |   84.61 |   82.32 | 83-92,149-172     
 ...learcut-logger |   76.94 |    95.23 |   66.66 |   76.94 |                   
  ...cut-logger.ts |   76.14 |       95 |   70.58 |   76.14 | ...77-387,390-392 
  ...tadata-key.ts |    82.6 |      100 |       0 |    82.6 | 143-153           
 src/tools         |   61.75 |    79.95 |   70.96 |   61.75 |                   
  diffOptions.ts   |     100 |      100 |     100 |     100 |                   
  edit.ts          |   77.74 |    81.15 |   84.61 |   77.74 | ...40-441,445-479 
  glob.ts          |   87.03 |       80 |   85.71 |   87.03 | ...89-290,298-305 
  grep.ts          |   56.59 |       75 |   72.72 |   56.59 | ...28-533,538-542 
  ls.ts            |    8.55 |      100 |    12.5 |    8.55 | ...89-194,202-312 
  mcp-client.ts    |   73.94 |    74.07 |   36.36 |   73.94 | ...35-336,355-356 
  mcp-tool.ts      |   91.75 |    85.71 |     100 |   91.75 | ...36,142,147-148 
  memoryTool.ts    |   97.43 |    84.84 |     100 |   97.43 | 93,95,97-98       
  ...iable-tool.ts |     100 |    84.61 |     100 |     100 | 90,97             
  read-file.ts     |   98.43 |    96.15 |     100 |   98.43 | 121-122           
  ...many-files.ts |   79.78 |    75.86 |   83.33 |   79.78 | ...67-468,475-476 
  shell.ts         |    4.04 |       50 |      50 |    4.04 | 33-365            
  tool-registry.ts |   51.23 |       80 |      80 |   51.23 | ...69-172,201-206 
  tools.ts         |   76.31 |      100 |      40 |   76.31 | ...44-145,154-159 
  web-fetch.ts     |   31.29 |    72.22 |   66.66 |   31.29 | ...90-191,219-359 
  web-search.ts    |   10.92 |      100 |      20 |   10.92 | ...01-102,105-194 
  write-file.ts    |   81.39 |       82 |   81.81 |   81.39 | ...05-310,371-400 
 src/utils         |   81.86 |    83.43 |   87.35 |   81.86 |                   
  LruCache.ts      |   70.96 |     62.5 |     100 |   70.96 | 20-22,28,30-34    
  bfsFileSearch.ts |   92.45 |    86.66 |     100 |   92.45 | 53-54,67-68       
  editCorrector.ts |   81.92 |     70.9 |     100 |   81.92 | ...42-554,588,602 
  editor.ts        |    97.1 |    93.18 |     100 |    97.1 | 118,178,181-182   
  ...rReporting.ts |   83.52 |    84.61 |     100 |   83.52 | 81-85,106-114     
  errors.ts        |   41.46 |       60 |      75 |   41.46 | 17-21,37-52,56-62 
  fetch.ts         |   34.04 |      100 |       0 |   34.04 | 22-27,31-57       
  fileUtils.ts     |   96.09 |    91.37 |     100 |   96.09 | 47,271-277        
  ...eUtilities.ts |   96.03 |       96 |     100 |   96.03 | 28-29,57-58       
  ...rStructure.ts |      95 |    93.42 |     100 |      95 | ...66-167,344-346 
  ...noreParser.ts |   96.36 |     90.9 |     100 |   96.36 | 70-71             
  gitUtils.ts      |   46.34 |    66.66 |      50 |   46.34 | 24-25,40-41,50-73 
  ...yDiscovery.ts |   80.24 |    75.43 |      75 |   80.24 | ...03-304,307-308 
  ...Inspectors.ts |     100 |      100 |     100 |     100 |                   
  ...kerChecker.ts |   83.14 |    82.35 |     100 |   83.14 | ...,94-99,107-113 
  paths.ts         |   62.79 |    73.33 |   57.14 |   62.79 | ...23-133,139-140 
  retry.ts         |   60.66 |     64.7 |     100 |   60.66 | ...46-166,211-226 
  ...aValidator.ts |     100 |      100 |     100 |     100 |                   
  session.ts       |     100 |      100 |     100 |     100 |                   
  user_id.ts       |   60.97 |    33.33 |      75 |   60.97 | ...33,46-48,52-57 
-------------------|---------|----------|---------|---------|-------------------

For detailed HTML reports, please see the 'coverage-reports-20.x' artifact from the main CI run.

cperry-goog

can you add a link from https://github.com/google-gemini/gemini-cli/blob/release/docs/cli/commands.md where we have /restore documented

and change the link at https://github.com/google-gemini/gemini-cli/blob/release/docs/cli/configuration.md to point to this

louisjimenez · 2025-06-24T01:33:36Z

can you add a link from https://github.com/google-gemini/gemini-cli/blob/release/docs/cli/commands.md where we have /restore documented

and change the link at https://github.com/google-gemini/gemini-cli/blob/release/docs/cli/configuration.md to point to this

Updated.

Co-authored-by: matt korwel <matt.korwel@gmail.com>

louisjimenez added the June25th Release label Jun 23, 2025

louisjimenez force-pushed the checkpoint-docs branch 2 times, most recently from 5dc1721 to f383c91 Compare June 23, 2025 12:03

Checkpointing documentation

70c5cb7

louisjimenez force-pushed the checkpoint-docs branch from f383c91 to 70c5cb7 Compare June 23, 2025 12:03

cperry-goog reviewed Jun 23, 2025

View reviewed changes

mattKorwel enabled auto-merge (squash) June 23, 2025 21:27

mattKorwel added the documentation label Jun 23, 2025

Merge branch 'release' into checkpoint-docs

7cf457b

louisjimenez force-pushed the checkpoint-docs branch from f7aee1f to 7cf457b Compare June 24, 2025 01:31

Merge branch 'release' into checkpoint-docs

54992c3

louisjimenez requested a review from cperry-goog June 24, 2025 13:46

Merge branch 'main' into checkpoint-docs

e25debb

mattKorwel approved these changes Jun 24, 2025

View reviewed changes

mattKorwel disabled auto-merge June 24, 2025 22:02

mattKorwel added this pull request to the merge queue Jun 24, 2025

mattKorwel removed this pull request from the merge queue due to the queue being cleared Jun 24, 2025

mattKorwel added this pull request to the merge queue Jun 24, 2025

Merged via the queue into main with commit 7421bf6 Jun 24, 2025
7 checks passed

mattKorwel deleted the checkpoint-docs branch June 24, 2025 22:34

yaleh pushed a commit to yaleh/gemini-cli that referenced this pull request Jun 29, 2025

Checkpointing documentation (google-gemini#1321)

989d69d

Co-authored-by: matt korwel <matt.korwel@gmail.com>

viridivn pushed a commit to viridivn/gemini-cli that referenced this pull request Jun 29, 2025

Checkpointing documentation (google-gemini#1321)

0ca2888

Co-authored-by: matt korwel <matt.korwel@gmail.com>

gemini-code-assist bot mentioned this pull request Feb 5, 2026

Add extension registry client #18396

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Checkpointing documentation#1321

Checkpointing documentation#1321
mattKorwel merged 4 commits intomainfrom
checkpoint-docs

louisjimenez commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025 •

edited

Loading

Uh oh!

cperry-goog left a comment

Uh oh!

louisjimenez commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

louisjimenez commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Uh oh!

cperry-goog left a comment

Choose a reason for hiding this comment

Uh oh!

louisjimenez commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Jun 23, 2025 •

edited

Loading