Modules@robinpath/linear
linear

@robinpath/linear

0.1.2Node.jsPublic

Linear module for RobinPath.

Linear

Linear module for RobinPath.

Package: @robinpath/linear | Category: Project Management | Type: Integration

Authentication

linear.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the linear module when you need to:

  • listIssues -- Use linear.listIssues to perform this operation
  • getIssue -- Use linear.getIssue to perform this operation
  • createIssue -- Use linear.createIssue to perform this operation
  • updateIssue -- Use linear.updateIssue to perform this operation
  • deleteIssue -- Use linear.deleteIssue to perform this operation

Quick Reference

FunctionDescriptionReturns
setCredentialsConfigure linear credentials.object
listIssueslistIssuesobject
getIssuegetIssueobject
createIssuecreateIssueobject
updateIssueupdateIssueobject
deleteIssuedeleteIssueobject
listProjectslistProjectsobject
getProjectgetProjectobject
createProjectcreateProjectobject
updateProjectupdateProjectobject
listTeamslistTeamsobject
getTeamgetTeamobject
listCycleslistCyclesobject
getCyclegetCycleobject
addIssueToCycleaddIssueToCycleobject
listLabelslistLabelsobject
createLabelcreateLabelobject
listCommentslistCommentsobject
createCommentcreateCommentobject
searchIssuessearchIssuesobject
listUserslistUsersobject

Functions

setCredentials

Configure linear credentials.

Module: linear | Returns: object -- API response.

linear.setCredentials
ParameterTypeRequiredDescription
apiKeystringYesapiKey

listIssues

listIssues

Module: linear | Returns: object -- API response.

linear.listIssues
ParameterTypeRequiredDescription
inputstringNoInput parameter

getIssue

getIssue

Module: linear | Returns: object -- API response.

linear.getIssue
ParameterTypeRequiredDescription
inputstringNoInput parameter

createIssue

createIssue

Module: linear | Returns: object -- API response.

linear.createIssue
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateIssue

updateIssue

Module: linear | Returns: object -- API response.

linear.updateIssue
ParameterTypeRequiredDescription
inputstringNoInput parameter

deleteIssue

deleteIssue

Module: linear | Returns: object -- API response.

linear.deleteIssue
ParameterTypeRequiredDescription
inputstringNoInput parameter

listProjects

listProjects

Module: linear | Returns: object -- API response.

linear.listProjects
ParameterTypeRequiredDescription
inputstringNoInput parameter

getProject

getProject

Module: linear | Returns: object -- API response.

linear.getProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

createProject

createProject

Module: linear | Returns: object -- API response.

linear.createProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateProject

updateProject

Module: linear | Returns: object -- API response.

linear.updateProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

listTeams

listTeams

Module: linear | Returns: object -- API response.

linear.listTeams
ParameterTypeRequiredDescription
inputstringNoInput parameter

getTeam

getTeam

Module: linear | Returns: object -- API response.

linear.getTeam
ParameterTypeRequiredDescription
inputstringNoInput parameter

listCycles

listCycles

Module: linear | Returns: object -- API response.

linear.listCycles
ParameterTypeRequiredDescription
inputstringNoInput parameter

getCycle

getCycle

Module: linear | Returns: object -- API response.

linear.getCycle
ParameterTypeRequiredDescription
inputstringNoInput parameter

addIssueToCycle

addIssueToCycle

Module: linear | Returns: object -- API response.

linear.addIssueToCycle
ParameterTypeRequiredDescription
inputstringNoInput parameter

listLabels

listLabels

Module: linear | Returns: object -- API response.

linear.listLabels
ParameterTypeRequiredDescription
inputstringNoInput parameter

createLabel

createLabel

Module: linear | Returns: object -- API response.

linear.createLabel
ParameterTypeRequiredDescription
inputstringNoInput parameter

listComments

listComments

Module: linear | Returns: object -- API response.

linear.listComments
ParameterTypeRequiredDescription
inputstringNoInput parameter

createComment

createComment

Module: linear | Returns: object -- API response.

linear.createComment
ParameterTypeRequiredDescription
inputstringNoInput parameter

searchIssues

searchIssues

Module: linear | Returns: object -- API response.

linear.searchIssues
ParameterTypeRequiredDescription
inputstringNoInput parameter

listUsers

listUsers

Module: linear | Returns: object -- API response.

linear.listUsers
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
Linear API error (${res.status}): ${t}Check the error message for details
linear.setCredentials requires apiKey.Check the error message for details
linear.updateIssue requires an ID.Check the error message for details
linear.deleteIssue requires an ID.Check the error message for details
linear.updateProject requires an ID.Check the error message for details
Linear: "..." not configured. Call linear.setCredentials first.Check the error message for details
@desc "List issues and validate result"
do
  set $result as linear.listIssues
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Issues

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "List issues and iterate results"
do
  set $result as linear.listIssues
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createIssue

Create a new resource and capture the result.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "Create issue"
do
  set $result as linear.createIssue
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "Create issue and update issue"
do
  set $created as linear.createIssue
  # Update the created item
  linear.updateIssue
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "List issues and create issue"
do
  set $existing as linear.listIssues
  if $existing == null
    linear.createIssue
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Linear workflow

Chain multiple linear operations together.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "List issues, get issue, and more"
do
  set $r_listIssues as linear.listIssues
  set $r_getIssue as linear.getIssue
  set $r_createIssue as linear.createIssue
  print "All operations complete"
enddo

6. Safe listIssues with validation

Check results before proceeding.

@desc "Setup authentication"
do
  linear.setCredentials $token
enddo

@desc "List issues and validate result"
do
  set $result as linear.listIssues
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

  • asana -- Asana module for complementary functionality
  • clickup -- ClickUp module for complementary functionality
  • jira -- Jira module for complementary functionality
  • monday -- Monday.com module for complementary functionality
  • todoist -- Todoist module for complementary functionality

Versions (1)

VersionTagPublished
0.1.2latest1 months ago
Install
$ robinpath add @robinpath/linear

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.2
LicenseMIT
Unpacked Size4.9 KB
Versions1
Weekly Downloads22
Total Downloads22
Stars0
Last Publish1 months ago
Created1 months ago

Category

productivity